WritableStreamDefaultWriter: abort() method
Baseline 2022
Newly available
Since June 2022, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.
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
reason
Optional-
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 Standard # ref-for-default-writer-abort④ |
Browser compatibility
BCD tables only load in the browser