ReadableStreamBYOBReader: cancel() メソッド
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
cancel() は ReadableStreamBYOBReader インターフェイスのメソッドで、ストリームがキャンセルされたときに解決するプロミス (Promise) を返します。
このメソッドを呼び出すと、コンシューマーがストリームへの関心を失ったことを示します。
メモ:
リーダーがアクティブな場合、 cancel() メソッドは、関連するストリームの場合（ReadableStream.cancel()）と同じように振る舞います。
構文
js
cancel()
cancel(reason)
引数
reason省略可-
人間が読むことができるキャンセルの理由です。基盤ソースは使用しても使用しなくても構いません。
返値
プロミス (Promise)。 reason 引数で指定された値で満たされます。
例外
TypeError-
ソースオブジェクトが
ReadableStreamBYOBReaderではないか、ストリームに所有者がいません。
例
このコード例では、ボタンが押されたときに cancel() メソッドを呼び出します。理由として文字列 "user choice" を渡します。
プロミスはキャンセルが完了すると解決します。
js
button.addEventListener("click", () => {
reader.cancel("user choice").then(() => console.log(`cancel complete`));
});
このコードは、読み取り可能なバイトストリームの使用の例で実行することができます（Cancel stream ボタンを押してください）。
仕様書
| Specification |
|---|
| Streams # ref-for-generic-reader-cancel② |