WritableStream: abort() method
Baseline
Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since May 2022.
Note: This feature is available in Web Workers.
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
| Specification |
|---|
| Streams # ref-for-ws-abort③ |
Browser compatibility
Loading…