ReadableStreamBYOBReader
Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:2650
The ReadableStreamBYOBReader interface of the Streams API defines a reader for a ReadableStream that supports zero-copy reading from an underlying byte source.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ReadableStreamBYOBReader(
stream):ReadableStreamBYOBReader
Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:2651
Parameters
Section titled “Parameters”stream
Section titled “stream”Returns
Section titled “Returns”ReadableStreamBYOBReader
Properties
Section titled “Properties”closed
Section titled “closed”
readonlyclosed:Promise<void>
Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:2652
Methods
Section titled “Methods”cancel()
Section titled “cancel()”cancel(
reason?):Promise<void>
Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:2653
Parameters
Section titled “Parameters”reason?
Section titled “reason?”any
Returns
Section titled “Returns”Promise<void>
read()
Section titled “read()”read<
T>(view):Promise<ReadableStreamReadResult<T>>
Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:2659
The read() method of the ReadableStreamBYOBReader interface is used to read data into a view on a user-supplied buffer from an associated readable byte stream.
Type Parameters
Section titled “Type Parameters”T extends ArrayBufferView<ArrayBufferLike>
Parameters
Section titled “Parameters”T
Returns
Section titled “Returns”Promise<ReadableStreamReadResult<T>>
readAtLeast()
Section titled “readAtLeast()”readAtLeast<
T>(minElements,view):Promise<ReadableStreamReadResult<T>>
Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:2668
Type Parameters
Section titled “Type Parameters”T extends ArrayBufferView<ArrayBufferLike>
Parameters
Section titled “Parameters”minElements
Section titled “minElements”number
T
Returns
Section titled “Returns”Promise<ReadableStreamReadResult<T>>
releaseLock()
Section titled “releaseLock()”releaseLock():
void
Defined in: node_modules/.pnpm/@cloudflare+workers-types@4.20251118.0/node_modules/@cloudflare/workers-types/index.ts:2667
The releaseLock() method of the ReadableStreamBYOBReader interface releases the reader’s lock on the stream.
Returns
Section titled “Returns”void