AbortSignal: abort event

فهرست فصل‌ها دانلود آرشیوناشر

MDN Web Docs · نسخهٔ df622a2a1c1e · CC BY-SA 2.5 و مجوز جداگانهٔ ناشر برای نمونه‌کد

{{APIRef("DOM")}}{{AvailableInWorkers}}

The **abort** event of the {{domxref("AbortSignal")}} is fired when the associated request is aborted, i.e., using {{domxref("AbortController.abort()")}}.

Syntax

Use the event name in {{domxref("EventTarget/addEventListener", "addEventListener()")}}:

js-nolint
addEventListener("abort", (event) => { })

Alternatively, assign to the event handler property of the interface:

js-nolint
onabort = (event) => { }

Event type

A generic {{DOMxRef("Event")}} with no added properties.

Examples

In the following snippets, we create a new AbortController object, and get its {{domxref("AbortSignal")}} (available using the signal property). Later on we check whether or not the signal has been aborted using an event handler property,

You can detect the abort event using an [addEventListener](/en-US/docs/Web/API/EventTarget/addEventListener) method:

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

signal.addEventListener("abort", () => {
  console.log("Request aborted");
});

Or use the onabort event handler property (but note that this replaces other event listeners added using onabort, if any):

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

signal.onabort = () => {
  console.log("Request aborted");
};

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}