Draft
This page is not complete.
Experimental
This is an experimental technology
Check 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 |
---|---|---|
Streams The definition of 'abort()' in that specification. |
Living Standard | Initial definition. |
Browser compatibility
BCD tables only load in the browser