W3cubDocs

/Web APIs

WritableStream: abort() method

The abort() method of the WritableStream interface aborts the stream, signaling that the producer can no longer successfully write to the stream and it is to be immediately moved to an error state, with any queued writes discarded.

Syntax

js

abort(reason)

Parameters

reason

A string providing a human-readable reason for the abort.

Return value

A Promise, which fulfills with the value given in the reason parameter.

Exceptions

TypeError

The stream you are trying to abort is not a WritableStream, or it is locked.

Examples

js

const writableStream = new WritableStream(
  {
    write(chunk) {
      // ...
    },
    close() {
      // ...
    },
    abort(err) {
      // ...
    },
  },
  queuingStrategy,
);

// ...

// abort the stream later on, when required
writableStream.abort();

Specifications

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
abort 59 16 100 No 47 14.1 59 59 100 44 14.5 7.0

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/WritableStream/abort