WritableStreamDefaultController.error

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

If the writer is active, the abort() method behaves the same as that for the associated stream (WriteableStream.abort()). If not, it returns a rejected promise.

Syntax

writableStreamDefaultControllerInstance.error(e);

Parameters

e

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

Return value

Void.

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

Browser compatibility

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