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
new ReadableStreamBYOBReader(stream)
Parameters
stream-
The
ReadableStreamto be read.
Return value
An instance of the ReadableStreamBYOBReader object.
Exceptions
TypeError-
Thrown if the supplied
streamparameter is not aReadableStream, or it is already locked for reading by another reader, or its stream controller is not aReadableByteStreamController.
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