WritableStreamDefaultWriter: abort()-Methode
Hinweis: Dieses Feature ist verfügbar in Web Workers.
Die abort()
-Methode der WritableStreamDefaultWriter
-Schnittstelle bricht den Stream ab und signalisiert, dass der Producer den Stream nicht mehr erfolgreich beschreiben kann. Der Stream wird sofort in einen Fehlerzustand versetzt, wobei alle in der Warteschlange befindlichen Schreibvorgänge verworfen werden.
Wenn der Writer aktiv ist, verhält sich die abort()
-Methode genauso wie bei dem zugehörigen Stream (WritableStream.abort()
). Ist dies nicht der Fall, wird ein abgelehntes Versprechen zurückgegeben.
Syntax
abort()
abort(reason)
Parameter
reason
Optional-
Ein String, der einen menschenlesbaren Grund für den Abbruch darstellt.
Rückgabewert
Ein Promise
, das mit undefined
erfüllt wird, wenn der Stream abgebrochen wird, oder mit einem Fehler abgelehnt wird, wenn der Writer inaktiv oder der Empfangs-Stream ungültig ist.
Ausnahmen
TypeError
-
Der Stream, den Sie versuchen abzubrechen, ist kein
WritableStream
oder 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
Specification |
---|
Streams Standard # ref-for-default-writer-abort④ |
Browser-Kompatibilität
BCD tables only load in the browser