WritableStreamDefaultController: error()-Methode

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

Die error()-Methode der WritableStreamDefaultController-Schnittstelle führt dazu, dass alle zukünftigen Interaktionen mit dem zugehörigen Stream fehlschlagen.

Diese Methode wird selten verwendet, da es normalerweise ausreicht, ein abgelehntes Promise von einer der Methoden des zugrunde liegenden Sinks zurückzugeben. Sie kann jedoch nützlich sein, um einen Stream plötzlich als Reaktion auf ein Ereignis abzuschalten, das außerhalb des normalen Lebenszyklus der Interaktionen mit dem zugrunde liegenden Sink liegt.

Syntax

js
error(message)

Parameter

message

Ein String, der den Fehler darstellt, mit dem zukünftige Interaktionen fehlschlagen sollen.

Rückgabewert

Keiner (undefined).

Ausnahmen

TypeError

Der Stream, den Sie versuchen fehlschlagen zu lassen, ist kein WritableStream.

Beispiele

js
const writableStream = new WritableStream({
  start(controller) {
    // do stuff with controller

    // error stream if necessary
    controller.error("My error is broken");
  },
  write(chunk, controller) {
    // ...
  },
  close(controller) {
    // ...
  },
  abort(err) {
    // ...
  },
});

Spezifikationen

Specification
Streams Standard
# ref-for-ws-default-controller-error①

Browser-Kompatibilität

BCD tables only load in the browser