WritableStreamDefaultController: Methode error()
Baseline
Weitgehend verfügbar
Diese Funktion ist gut etabliert und funktioniert auf vielen Geräten und in vielen Browserversionen. Sie ist seit Mai 2022 browserübergreifend verfügbar.
Hinweis: Diese Funktion ist in Web Workers verfügbar.
Die Methode error() des Interfaces WritableStreamDefaultController bewirkt, dass alle zukünftigen Interaktionen mit dem zugehörigen Stream mit einem Fehler fehlschlagen.
Diese Methode wird selten verwendet, da es normalerweise ausreicht, aus einer der Methoden der zugrunde liegenden Senke ein abgelehntes Promise zurückzugeben. Sie kann jedoch nützlich sein, um einen Stream als Reaktion auf ein Ereignis außerhalb des normalen Ablaufs der Interaktionen mit der zugrunde liegenden Senke abrupt zu beenden.
Syntax
error(message)
Parameter
message-
Ein String, der den Fehler angibt, mit dem zukünftige Interaktionen fehlschlagen sollen.
Rückgabewert
Keiner (undefined).
Ausnahmen
TypeError-
Der Stream, für den Sie einen Fehler auslösen möchten, ist kein
WritableStream.
Beispiele
const writableStream = new WritableStream({
start(controller) {
// do stuff with controller
// error stream if necessary
controller.error("My error is broken");
},
write(chunk, controller) {
// …
},
close() {
// …
},
abort(err) {
// …
},
});
Spezifikationen
| Spezifikation |
|---|
| Streams # ref-for-ws-default-controller-error① |