ReadableStreamBYOBReader: cancel() Methode

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

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

Die cancel() Methode der ReadableStreamBYOBReader-Schnittstelle gibt ein Promise zurück, das aufgelöst wird, wenn der Stream abgebrochen wird. Das Aufrufen dieser Methode signalisiert das Desinteresse eines Verbrauchers an dem Stream.

Hinweis: Wenn der Leser aktiv ist, verhält sich die cancel()-Methode genauso wie die für den zugehörigen Stream (ReadableStream.cancel()).

Syntax

js
cancel()
cancel(reason)

Parameter

reason Optional

Ein menschenlesbarer Grund für die Stornierung. Die zugrunde liegende Quelle kann ihn verwenden oder nicht.

Rückgabewert

Ein Promise, das mit dem im reason-Parameter angegebenen Wert erfüllt wird.

Ausnahmen

TypeError

Das Quellobjekt ist kein ReadableStreamBYOBReader, oder der Stream hat keinen Besitzer.

Beispiele

Dieses Beispiel ruft die cancel()-Methode auf, wenn ein Button gedrückt wird, und übergibt den String "user choice" als Grund. Das Promise wird aufgelöst, wenn die Stornierung abgeschlossen ist.

js
button.addEventListener("click", () => {
  reader.cancel("user choice").then(() => console.log(`cancel complete`));
});

Beachten Sie, dass dieser Code im Verwenden von lesbaren Byte-Streams-Beispielcode ausgeführt werden kann (drücken Sie die Cancel stream-Taste).

Spezifikationen

Specification
Streams
# ref-for-generic-reader-cancel②

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
cancel

Legend

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

Full support
Full support
No support
No support

Siehe auch