WritableStreamDefaultWriter: abort() Methode
Baseline
Weitgehend verfügbar
Diese Funktion ist gut etabliert und funktioniert auf vielen Geräten und in vielen Browserversionen. Sie ist seit Mai 2022 browserübergreifend verfügbar.
Hinweis: Diese Funktion ist in Web Workers verfügbar.
Die abort()-Methode des WritableStreamDefaultWriter-Interfaces bricht den Stream ab und signalisiert, dass der Erzeuger nicht mehr erfolgreich in den Stream schreiben kann und dieser sofort in einen Fehlerzustand versetzt wird, wobei alle wartenden Schreibvorgänge verworfen werden.
Wenn der Writer aktiv ist, verhält sich die abort()-Methode genauso wie die des zugehörigen Streams (WritableStream.abort()). Andernfalls gibt sie ein abgelehntes Promise zurück.
Syntax
abort()
abort(reason)
Parameter
reasonOptional-
Ein String, der einen für Menschen lesbaren Grund für den Abbruch darstellt.
Rückgabewert
Ein Promise, das auf undefined erfüllt wird, wenn der Stream abgebrochen wird, oder bei einem Fehler ablehnt, wenn der Writer inaktiv war oder der empfangende Stream ungültig ist.
Ausnahmen
TypeError-
Der Stream, den Sie abzubrechen versuchen, ist kein
WritableStream, oder er ist gesperrt.
Beispiele
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: ...");
Spezifikationen
| Spezifikation |
|---|
| Streams # ref-for-default-writer-abort④ |