WritableStreamDefaultWriter: 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
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
reasonOptional-
A string representing a human-readable reason for the abort.
Return value
A Promise, which fulfills to undefined when the stream is aborted, or
rejects with an error if the writer was inactive or the receiver stream is invalid.
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
await writer.abort("WritableStream aborted. Reason: ...");
Specifications
| Specification |
|---|
| Streams # ref-for-default-writer-abort④ |
Browser compatibility
| desktop | mobile | server | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
abort
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support