WritableStreamDefaultController.WritableStreamDefaultController()

Draft
This page is not complete.

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

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

Note: You wouldn't use this constructor manually — this is used during the construction of a WritableStream object.

Syntax

var writableStreamController = new WritableStreamDefaultController(stream, underlyingSink, size, highWaterMark);

Parameters

stream
The WritableStream to be controlled.
underlyingSink
An object containing methods and properties that define how the constructed stream instance will behave. See the WritableStream() constructor's parameter definitions for more information.
size
A method containing a parameter chunk — this indicates the size to use for each chunk, in bytes.
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 WritableStreamDefaultController object.

Exceptions

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

Examples

TBD

Specifications

Specification Status Comment
Streams
The definition of 'WritableStreamDefaultController()' in that specification.
Living Standard Initial definition.

Browser compatibility

No compatibility data found. Please contribute data for "path.to.feature.NameOfTheConstructor" (depth: 1) to the MDN compatibility data repository.

Document Tags and Contributors

 Contributors to this page: chrisdavidmills
 Last updated by: chrisdavidmills,