WritableStreamDefaultController: error() メソッド
Baseline
広く利用可能
この機能は広く実装されており、多くのバージョンの端末やブラウザーで動作します。2022年5月以降、すべてのブラウザーで利用可能です。
メモ: この機能はウェブワーカー内で利用可能です。
WritableStreamDefaultController インターフェイスの error() メソッドにより、関連するストリームとの今後のやり取りがエラーになります。
通常、基になるシンクのメソッドの 1 つから拒否されたプロミスを返すだけで十分なため、このメソッドはほとんど使用されません。 ただし、基になるシンクとのやり取りの通常のライフサイクル外のイベントに応答して、ストリームを突然シャットダウンする場合に役立ちます。
構文
js
error(message)
引数
message-
文字列で、将来の操作を失敗するようにしたいエラーを表します。
返値
なし (undefined)。
例外
TypeError-
エラーにしようとしているストリームは
WritableStreamではありません。
例
js
const writableStream = new WritableStream({
start(controller) {
// コントローラーで何かをする
// 必要に応じてストリームをエラーにする
controller.error("My error is broken");
},
write(chunk, controller) {
// ...
},
close(controller) {
// ...
},
abort(err) {
// ...
},
});
仕様書
| 仕様書 |
|---|
| Streams # ref-for-ws-default-controller-error① |