ReadableByteStreamController.constructor

The ReadableByteStreamController() constructor creates and returns a ReadableByteStreamController() object instance.

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 with autoAllocateChunkSize set, but its value is not an integer or below 0.

TypeError

The supplied stream parameter is not a ReadableStream, or it already has an associated controller.

Examples

TBD

Specifications

Browser compatibilityUpdate compatibility data on GitHub