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.

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

abortAbortSignal のイベントで、関連するリクエストが中止されたとき、つまり AbortController.abort() を使用して中止されたときに発行されます。

構文

このイベント名を addEventListener() などのメソッドで使用するか、イベントハンドラープロパティを設定するかしてください。

js
addEventListener('abort', (event) => { })

onabort = (event) => { }

イベント型

一般的な Event で、追加のプロパティはありません。

以下のスニペットでは、新しい AbortController オブジェクトを作成し、その AbortSignalsignal プロパティを使用して利用できます)を取得します。次に、イベントハンドラープロパティを使用して、シグナルが中止されたかどうかを調べます。

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
# eventdef-abortsignal-abort
DOM
# abortsignal-onabort

ブラウザーの互換性

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 event

Legend

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

Full support
Full support