WritableStream.abort()

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

構文

abort(reason)

引数

reason

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

返値

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

例外

TypeError

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

例

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