WritableStream: abort()-Methode

Hinweis: Dieses Feature ist verfügbar in Web Workers.

Die abort()-Methode der WritableStream-Schnittstelle bricht den Stream ab. Sie signalisiert, dass der Produzent nicht mehr erfolgreich in den Stream schreiben kann und dieser sofort in einen Fehlerzustand versetzt werden soll, wobei alle eingereihten Schreibvorgänge verworfen werden.

Syntax

js
abort(reason)

Parameter

reason

Ein String, der einen menschenlesbaren Grund für den Abbruch angibt.

Rückgabewert

Ein Promise, das mit dem im reason-Parameter angegebenen Wert erfüllt wird.

Ausnahmen

TypeError

Der Stream, den Sie abzubrechen versuchen, ist kein WritableStream oder er ist gesperrt.

Beispiele

js
const writableStream = new WritableStream(
  {
    write(chunk) {
      // ...
    },
    close() {
      // ...
    },
    abort(err) {
      // ...
    },
  },
  queuingStrategy,
);

// ...

// abort the stream later on, when required
writableStream.abort();

Spezifikationen

Specification
Streams Standard
# ref-for-ws-abort③

Browser-Kompatibilität

BCD tables only load in the browser