WritableStreamDefaultWriter.abort()

Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The abort() method of the WritableStreamDefaultWriter 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.

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

Syntax

abort()
abort(reason)

Parameters

reason Optional

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

Return value

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

Exceptions

{{jsxsref("TypeError")}}

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

Examples

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

...

const writer = writableStream.getWriter();

...

// abort the stream when desired
writer.abort.then((reason) => {
  console.log(reason);
})

Specifications

Specification
Streams Standard
# ref-for-default-writer-abort④

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
99-100
No
46
14.1
59
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/WritableStreamDefaultWriter/abort

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