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 aWritableStream
, or it already has an associated controller.
Examples
const writableStream = new WritableStream({
start(controller) {
// do stuff with controller
// error stream if necessary
controller.error('My error is broken');
},
write(chunk, controller) {
...
},
close(controller) {
...
},
abort(err) {
...
}
});
Specifications
Specification | Status | Comment |
---|---|---|
Streams The definition of 'WritableStreamDefaultController()' 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.