ReadableStreamBYOBReader()

The ReadableStreamBYOBReader() constructor creates and returns a ReadableStreamBYOBReader object instance.

Note: You generally wouldn't use this constructor manually; instead, you'd use the ReadableStream.getReader() method with the argument "byob".

Syntax

new ReadableStreamBYOBReader(stream)

Parameters

stream

The ReadableStream to be read.

Return value

An instance of the ReadableStreamBYOBReader object.

Exceptions

TypeError

Thrown if the supplied stream parameter is not a ReadableStream, or it is already locked for reading by another reader, or its stream controller is not a ReadableByteStreamController.

Examples

The constructor is rarely called directly. Instead call ReadableStream.getReader() as shown:

const reader = stream.getReader({mode: "byob"});

Specifications

Specification
Streams Standard
# ref-for-byob-reader-constructor①

Browser compatibility

BCD tables only load in the browser