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.
メモ: この機能はウェブワーカー内で利用可能です。
abort
は AbortSignal
のイベントで、関連するリクエストが中止されたとき、つまり AbortController.abort()
を使用して中止されたときに発行されます。
構文
このイベント名を addEventListener()
などのメソッドで使用するか、イベントハンドラープロパティを設定するかしてください。
js
addEventListener('abort', (event) => { })
onabort = (event) => { }
イベント型
一般的な Event
で、追加のプロパティはありません。
例
以下のスニペットでは、新しい AbortController
オブジェクトを作成し、その AbortSignal
(signal
プロパティを使用して利用できます)を取得します。次に、イベントハンドラープロパティを使用して、シグナルが中止されたかどうかを調べます。
abort
イベントを addEventListener
メソッドで検出することができます。
js
const controller = new AbortController();
const signal = controller.signal;
signal.addEventListener("abort", () => {
console.log("Request aborted");
});
または、 onabort
イベントハンドラープロパティを使用してください。
js
const controller = new AbortController();
const signal = controller.signal;
signal.onabort = () => {
console.log("Request aborted");
};
仕様書
Specification |
---|
DOM Standard # eventdef-abortsignal-abort |
DOM Standard # abortsignal-onabort |
ブラウザーの互換性
BCD tables only load in the browser