WritableStreamDefaultController: error() 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 error() Methode der WritableStreamDefaultController Schnittstelle verursacht, dass alle zukünftigen Interaktionen mit dem zugehörigen Stream fehlerhaft werden.

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 in Reaktion auf ein Ereignis außerhalb des normalen Lebenszyklus von Interaktionen mit dem zugrunde liegenden Sink zu beenden.

Syntax

js
error(message)

Parameter

message

Ein String, der den Fehler repräsentiert, mit dem zukünftige Interaktionen fehlschlagen sollen.

Rückgabewert

Keiner (undefined).

Ausnahmen

TypeError

Der Stream, den Sie fehlerhaft machen möchten, 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
# ref-for-ws-default-controller-error①

Browser-Kompatibilität