WritableStreamDefaultController: error()-Methode

Hinweis: Diese Funktion ist in Web Workers verfügbar.

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
# ref-for-ws-default-controller-error①

Browser-Kompatibilität

Report problems with this compatibility data on GitHub
desktopmobileserver
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
Deno
Node.js
error

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support