WritableStreamDefaultWriter: `abort()` Methode

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since May 2022.

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

js
abort()
abort(reason)

Parameter

reason Optional

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

js
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
# ref-for-default-writer-abort④

Browser-Kompatibilität