ReadableStreamBYOBReader: ReadableStreamBYOBReader() constructor
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
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
Browser compatibility
|
Desktop |
Mobile |
|
Chrome |
Edge |
Firefox |
Internet Explorer |
Opera |
Safari |
WebView Android |
Chrome Android |
Firefox for Android |
Opera Android |
Safari on IOS |
Samsung Internet |
ReadableStreamBYOBReader |
89 |
89 |
102 |
No |
75 |
No |
89 |
89 |
102 |
63 |
No |
15.0 |
See also