Web/API/WritableStreamDefaultController/error

Draft This page is not complete.

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

The error() method of the WritableStreamDefaultController interface causes any future interactions with the associated stream to error.

This method is rarely used, since usually it suffices to return a rejected promise from one of the underlying sink’s methods. However, it can be useful for suddenly shutting down a stream in response to an event outside the normal lifecycle of interactions with the underlying sink.

Syntax

writableStreamDefaultController.error(e);

Parameters

e: A DOMString representing the error you want future interactions to fail with.

Return value

undefined.

Exceptions

TypeError: The stream you are trying to error is not a WritableStream.

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
StreamsThe definition of 'error()' in that specification.	Living Standard	Initial definition.

Browser compatibility

Update compatibility data on GitHub

	Desktop						Mobile
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
`error` Experimental'	Chrome ?	Edge Full support 16	Firefox No support No	IE No support No	Opera ?	Safari ?	WebView Android ?	Chrome Android ?	Firefox Android No support No	Opera Android ?	Safari iOS ?	Samsung Internet Android ?

Legend

Full support: Full support
No support: No support
Compatibility unknown: Compatibility unknown
Experimental. Expect behavior to change in the future.': Experimental. Expect behavior to change in the future.

WritableStreamDefaultController.error() by Mozilla Contributors is licensed under CC-BY-SA 2.5.