WritableStream: abort() メソッド
Baseline
広く利用可能
この機能は広く実装されており、多くのバージョンの端末やブラウザーで動作します。2022年5月以降、すべてのブラウザーで利用可能です。
abort() は WritableStream インターフェイスのメソッドで、ストリーミングを中止し、プロデューサーがストリームに正常に書き込むことができなくなり、キューに入れられた書き込みが破棄されてすぐにエラー状態に移行することを通知します。
構文
js
abort(reason)
引数
reason-
人間が読むことのできる文字列で、中止した理由を提供します。
返値
Promise です。 reason 引数で指定された値で履行されます。
例外
TypeError-
中止しようとしているストリームは
WritableStreamではないか、ロックされています。
例
js
const writableStream = new WritableStream(
{
write(chunk) {
// ...
},
close() {
// ...
},
abort(err) {
// ...
},
},
queuingStrategy,
);
// ...
// 必要に応じて、後でストリームを中止します
writableStream.abort();
仕様書
| 仕様書 |
|---|
| Streams # ref-for-ws-abort③ |