WritableStreamDefaultController.error()

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

error(e)

Parameters

e

A string representing the error you want future interactions to fail with.

Return value

undefined.

Exceptions

{{jsxsref("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
Streams Standard
# ref-for-ws-default-controller-error①

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
error
59
16
100
99-100
No
46
14.1
58
59
100
43
14.5
7.0

© 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/error

Name Web APIs
Version
Badge
Last Updated 2022-04-27T09:33:08Z