ReadableStreamBYOBReader.cancel()
Experimental: これは実験的な機能です。
本番で使用する前にブラウザー互換性一覧表をチェックしてください。
ReadableStreamBYOBReader インターフェイスの cancel() メソッドはストリームをキャンセルし、コンシューマーがストリームに興味を失ったことを通知します。 提供された reason パラメーターは、基になるソースに与えられ、使用する場合もしない場合もあります。
メモ: リーダーがアクティブな場合、cancel() メソッドは、関連するストリームの場合（ReadableStream.cancel()）と同じように振る舞います。
構文
var promise = readableStreamBYOBReader.cancel(reason);
パラメーター
- reason
-
人間が読むことができるキャンセルの理由を提供する
DOMString。
戻り値
Promise。 reason パラメーターで指定された値で満たされます。
例外
- TypeError
-
ソースオブジェクトが
ReadableStreamBYOBReaderではないか、ストリームに所有者がいません。
例
未定。
仕様
| Specification |
|---|
| Streams Standard # ref-for-generic-reader-cancel② |
ブラウザーの互換性
BCD tables only load in the browser