WritableStreamDefaultWriter: abort() メソッド
Baseline 2022
Newly available
Since June 2022, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.
abort()
は WritableStreamDefaultWriter
インターフェイスのメソッドで、ストリームを中止し、プロデューサーがストリームに正常に書き込むことができなくなり、キューに書き込まれた書き込みを破棄してすぐにエラー状態に移行することを通知します。
ライターがアクティブな場合、abort()
メソッドは、関連するストリーム(WritableStream.abort()
)と同じように振る舞います。 そうでない場合、拒否されたプロミスを返します。
構文
js
abort()
abort(reason)
引数
reason
省略可-
文字列で、人間が読むことができる中止の理由を表します。
返値
Promise
です。 reason
引数で指定された値で履行されます。
例外
TypeError
-
中止しようとしているストリームが
WritableStream
ではないか、ロックされている場合。
例
js
const writableStream = new WritableStream(
{
write(chunk) {
// ...
},
close() {
// ...
},
abort(err) {
// ...
},
},
queuingStrategy,
);
// ...
const writer = writableStream.getWriter();
// ...
// 必要に応じてストリームを中止します
writer.abort.then((reason) => {
console.log(reason);
});
仕様書
Specification |
---|
Streams Standard # ref-for-default-writer-abort④ |
ブラウザーの互換性
BCD tables only load in the browser