WritableStream: 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() は WritableStream インターフェイスのメソッドで、ストリーミングを中止し、プロデューサーがストリームに正常に書き込むことができなくなり、キューに入れられた書き込みが破棄されてすぐにエラー状態に移行することを通知します。

構文

js
abort(reason)

引数

reason

人間が読むことのできる文字列で、中止した理由を提供します。

返値

Promise です。 reason 引数で指定された値で履行されます。

例外

TypeError

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

例

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

// ...

// 必要に応じて、後でストリームを中止します
writableStream.abort();

仕様書

Specification
Streams Standard
# ref-for-ws-abort③

ブラウザーの互換性

BCD tables only load in the browser