AbortSignal: abort() 静的メソッド

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since March 2019.

メモ: この機能はウェブワーカー内で利用可能です。

AbortSignal.abort() は静的メソッドで、既に中止と設定されている(かつ abort イベントが発生していない) AbortSignal を返します。

これは、以下のコードの一連で行うものです。

js
const controller = new AbortController();
controller.abort();
return controller.signal;

これは、例えば、フェッチメソッドの中止ロジックを実行するために渡される可能性があります (つまり、意図したフェッチ処理が開始されていなくても中止ロジックが実行されるように コードが構成されていることがあります)。

メモ: このメソッドは Promise.reject と同じような目的を持っています。

構文

js
AbortSignal.abort()
AbortSignal.abort(reason)

引数

reason

処理が中断された理由。任意の JavaScript の値を指定可能です。 指定しない場合、理由は "AbortError" DOMException に設定されます。

返値

AbortSignal インスタンスの AbortSignal.aborted プロパティを true に設定し、 AbortSignal.reason に指定された(または既定の)理由を設定したものです。

仕様書

Specification
DOM Standard
# ref-for-dom-abortsignal-abort①

ブラウザーの互換性

BCD tables only load in the browser