ReadableByteStreamController
The ReadableByteStreamController interface of the Streams API represents a controller for a readable byte stream. It allows control of the state and internal queue of a ReadableStream with an underlying byte source, and enables efficient zero-copy transfer of data from the underlying source to a consumer when the stream's internal queue is empty.
Methods
close()
close(): void;
The close() method of the ReadableByteStreamController interface closes the associated stream.
Returns
void
enqueue()
enqueue(chunk): void;
The enqueue() method of the ReadableByteStreamController interface enqueues a given chunk on the associated readable byte stream (the chunk is transferred into the stream's internal queues).
Parameters
| Parameter | Type |
|---|---|
chunk | ArrayBufferView<ArrayBuffer> |
Returns
void
error()
error(e?): void;
The error() method of the ReadableByteStreamController interface causes any future interactions with the associated stream to error with the specified reason.
Parameters
| Parameter | Type |
|---|---|
e? | any |
Returns
void
Properties
byobRequest
readonly byobRequest: ReadableStreamBYOBRequest | null;
The byobRequest read-only property of the ReadableByteStreamController interface returns the current BYOB request, or null if there are no pending requests.
desiredSize
readonly desiredSize: number | null;
The desiredSize read-only property of the ReadableByteStreamController interface returns the number of bytes required to fill the stream's internal queue to its "desired size".