WritableStreamDefaultWriter: abort() method
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
Parameters
reason
Optional
-
A string 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();
writer.abort.then((reason) => {
console.log(reason);
});
Specifications
Browser compatibility
|
Desktop |
Mobile |
|
Chrome |
Edge |
Firefox |
Internet Explorer |
Opera |
Safari |
WebView Android |
Chrome Android |
Firefox for Android |
Opera Android |
Safari on IOS |
Samsung Internet |
abort |
59 |
16 |
100 |
No |
46 |
14.1 |
59 |
59 |
100 |
43 |
14.5 |
7.0 |