The WritableStreamDefaultController
interface of the Streams API represents a controller allowing control of a WritableStream
's state. When constructing a WritableStream
, the underlying sink is given a corresponding WritableStreamDefaultController
instance to manipulate.
WritableStreamDefaultController
Constructor
None. WritableStreamDefaultController
instances are created automatically during WritableStream
construction.
Properties
None.
Methods
-
WritableStreamDefaultController.error()
-
Causes any future interactions with the associated stream to error.
Examples
const writableStream = new WritableStream({ start(controller) { // do stuff with controller // error stream if necessary controller.error('My stream is broken'); }, write(chunk, controller) { ... }, close(controller) { ... }, abort(err) { ... } });
Specifications
Specification |
---|
Streams Standard # ws-default-controller-class |
Browser compatibility
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
WritableStreamDefaultController |
58
|
16
|
100
99-100
|
No
|
45
|
14.1
|
58
|
58
|
100
|
43
|
14.5
|
7.0
|
error |
59
|
16
|
100
99-100
|
No
|
46
|
14.1
|
58
|
59
|
100
|
43
|
14.5
|
7.0
|
signal |
No
|
No
|
100
99-100
|
No
|
No
|
No
|
No
|
No
|
100
|
No
|
No
|
No
|
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/WritableStreamDefaultController