Draft
This page is not complete.
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
var promise = writableStreamDefaultWriter.abort(reason);
Parameters
- reason Optional
- A
DOMString
representing 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); ... const writer = writableStream.getWriter(); ... // abort the stream when desired writer.abort.then((reason) => { console.log(reason); })
Specifications
Specification | Status | Comment |
---|---|---|
Streams The definition of 'abort()' in that specification. |
Living Standard | Initial definition. |
Browser compatibility
The compatibility table on 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.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
abort | Chrome Full support 59 | Edge Full support 16 | Firefox No support No | IE No support No | Opera Full support 46 | Safari ? | WebView Android Full support 59 | Chrome Android Full support 59 | Firefox Android No support No | Opera Android Full support 43 | Safari iOS ? | Samsung Internet Android Full support 7.0 |
Legend
- Full support
- Full support
- No support
- No support
- Compatibility unknown
- Compatibility unknown
- Experimental. Expect behavior to change in the future.
- Experimental. Expect behavior to change in the future.