ReadableStreamBYOBReader

The ReadableStreamDefaultReader interface of the Streams API represents a BYOB ("bring your own buffer") reader that can be used to read stream data supplied by the developer (e.g. a custom ReadableStream.ReadableStream() constructor).

Constructor

ReadableStreamBYOBReader()

Creates and returns a ReadableStreamBYOBReader() object instance.

Properties

ReadableStreamBYOBReader.closed

Allows you to write code that responds to an end to the streaming process. Returns a promise that fulfills if the stream becomes closed or the reader's lock is released, or rejects if the stream errors.

Methods

ReadableStreamBYOBReader.cancel()

Cancels the stream, signaling a loss of interest in the stream by a consumer. The supplied reason argument will be given to the underlying source, which may or may not use it.

ReadableStreamBYOBReader.read()

Returns a promise providing access to the next chunk in the stream's internal queue.

ReadableStreamBYOBReader.releaseLock()

Releases the reader's lock on the stream.

Examples

TBD.

Specifications

Browser compatibility