Web/API/WritableStream/abort

Draft This page is not complete.

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

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

var promise = writableStream.abort(reason);

Parameters

reason

A DOMString 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

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

...

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

Specifications

Specification	Status	Comment
StreamsThe definition of 'abort()' in that specification.	Living Standard	Initial definition.

Browser compatibility

The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.

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
abort	Chrome Full support 59	Edge Full support 16	Firefox No support No	IE No support No	Opera Full support 47	Safari ?	WebView Android Full support 59	Chrome Android Full support 59	Firefox Android No support No	Opera Android Full support 44	Safari iOS ?	Samsung Internet Android Full support 7.0

Legend

Full support  

Full support

No support  

No support

Compatibility unknown  

Compatibility unknown

WritableStream.abort() by Mozilla Contributors is licensed under CC-BY-SA 2.5.