ReadableStreamBYOBReader: cancel() Methode
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
cancel()
cancel(reason)
Parameter
reasonOptional-
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.
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 Standard # ref-for-generic-reader-cancel② |
Browser-Kompatibilität
BCD tables only load in the browser