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②

ブラウザーの互換性

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

関連情報