WritableStreamDefaultWriter: abort() メソッド

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

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

構文

js
abort()
abort(reason)

引数

reason 省略可

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

返値

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

例外

TypeError

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

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

// ...

const writer = writableStream.getWriter();

// ...

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

仕様書

Specification
Streams
# ref-for-default-writer-abort④

ブラウザーの互換性

Report problems with this compatibility data on GitHub
desktopmobileserver
Chrome
Edge
Firefox
Opera
Safari
Chrome Android
Firefox for Android
Opera Android
Safari on iOS
Samsung Internet
WebView Android
WebView on iOS
Deno
Node.js
abort

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support