ReadableStreamBYOBReader: ReadableStreamBYOBReader() constructor

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

Note: This feature is available in Web Workers.

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

js
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:

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

Specifications

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

Browser compatibility

Report problems with this compatibility data on GitHub
desktopmobileserver
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
Deno
Node.js
ReadableStreamBYOBReader() constructor

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
No support
No support

See also