ReadableStreamBYOBReader
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The ReadableStreamBYOBReader
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()
constructor).
Constructor
ReadableStreamBYOBReader()
-
Creates and returns a
ReadableStreamBYOBReader
object instance.
Properties
ReadableStreamBYOBReader.closed
Read only-
Returns a
Promise
that fulfills when the stream closes, or rejects if the stream throws an error or the reader's lock is released. This property enables you to write code that responds to an end to the streaming process.
Methods
ReadableStreamBYOBReader.cancel()
-
Returns a
Promise
that resolves when the stream is canceled. Calling this method signals a loss of interest in the stream by a consumer. The suppliedreason
argument will be given to the underlying source, which may or may not use it. ReadableStreamBYOBReader.read()
-
Returns a
Promise
that resolves with an object indicating the state of the stream: either the next chunk in the stream or an indication that the stream is closed. ReadableStreamBYOBReader.releaseLock()
-
Releases the reader's lock on the stream.
Examples
TBD.
Specifications
Specification |
---|
Streams Standard # byob-reader-class |
Browser compatibility
BCD tables only load in the browser