WritableStreamDefaultController.error()

草案

このページは完成していません。

Experimental

これは実験的な機能です。
本番で使用する前にブラウザー互換性一覧表をチェックしてください。

WritableStreamDefaultController インターフェイスの error() メソッドにより、関連するストリームとの今後のやり取りがエラーになります。

通常、基になるシンクのメソッドの1つから拒否された promise を返すだけで十分なため、このメソッドはほとんど使用されません。ただし、基になるシンクとのやり取りの通常のライフサイクル外のイベントに応答して、ストリームを突然シャットダウンする場合に役立ちます。

構文

writableStreamDefaultController.error(e);

パラメーター

e: 今後のやり取りを失敗させたいエラーを表す DOMString。

戻り値

undefined。

例外

TypeError: エラーにしようとしているストリームは WritableStream ではありません。

例

const writableStream = new WritableStream({
  start(controller) {
    // コントローラーで何かをする

    // 必要に応じてストリームをエラーにする
    controller.error('My error is broken');
  },
  write(chunk, controller) {
    ...
  },
  close(controller) {
    ...
  },
  abort(err) {
    ...
  }
});

仕様

仕様	状態	コメント
Streams error() の定義	現行の標準	初期定義

ブラウザーの互換性

BCD tables only load in the browser