Draft
This page is not complete.
This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
The ReadableByteStreamController()
constructor creates and returns a ReadableByteStreamController()
object instance.
Note: You wouldn't use this constructor manually — this is used during the construction of a ReadableStream
object.
Syntax
var readableStreamController = new ReadableStreamController(stream, underlyingSource, highWaterMark);
Parameters
- stream
- The
ReadableStream
to be controlled. - underlyingSource
- An object containing methods and properties that define how the constructed stream instance will behave. See the
ReadableStream()
constructor's parameters definitions for more information. - highWaterMark
- A non-negative integer — this defines the total number of chunks that can be contained in the internal queue before backpressure is applied.
Return value
An instance of the ReadableByteStreamController
object.
Exceptions
- RangeError
- The associated
ReadableStream
was constructed withautoAllocateChunkSize
set, but its value is not an integer or below 0. - TypeError
- The supplied
stream
parameter is not aReadableStream
, or it already has an associated controller.
Examples
TBD
Specifications
Specification | Status | Comment |
---|---|---|
Streams The definition of 'ReadableByteStreamController()' in that specification. |
Living Standard | Initial definition. |
Browser compatibility
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
No compatibility data found. Please contribute data for "path.to.feature.NameOfTheConstructor" (depth: 1) to the MDN compatibility data repository.