WritableStreamDefaultWriter.abort()

草案

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

Experimental

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

WritableStreamDefaultWriter インターフェイスの abort() メソッドはストリームを中止し、プロデューサーがストリームに正常に書き込むことができなくなり、キューに書き込まれた書き込みを破棄してすぐにエラー状態に移行することを通知します。

ライターがアクティブな場合、abort() メソッドは、関連するストリーム(WritableStream.abort())と同じように振る舞います。 そうでない場合、拒否された promise を返します。

構文

var promise = writableStreamDefaultWriter.abort(reason);

パラメーター

reason 省略可
人間が読むことができる中止の理由を提供する DOMString

戻り値

Promisereason パラメーターで指定された値で満たされます。

例外

TypeError
中止しようとしているストリームは WritableStream ではないか、ロックされています。

const writableStream = new WritableStream({
  write(chunk) {
    ...
  },
  close() {
    ...
  },
  abort(err) {
    ...
  }
}, queuingStrategy);

...

const writer = writableStream.getWriter();

...

// 必要に応じてストリームを中止します
writer.abort.then((reason) => {
  console.log(reason);
})

仕様

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

ブラウザーの互換性

BCD tables only load in the browser