AbortSignal: abort event
Baseline
Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since April 2018.
Note: This feature is available in Web Workers.
The abort event of the AbortSignal is fired when the associated request is aborted, i.e., using AbortController.abort().
Syntax
Use the event name in methods like addEventListener(), or set an event handler property.
addEventListener("abort", (event) => { })
onabort = (event) => { }
Event type
A generic Event with no added properties.
Examples
In the following snippets, we create a new AbortController object, and get its 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 method:
const controller = new AbortController();
const signal = controller.signal;
signal.addEventListener("abort", () => {
console.log("Request aborted");
});
Or use the onabort event handler property:
const controller = new AbortController();
const signal = controller.signal;
signal.onabort = () => {
console.log("Request aborted");
};
Specifications
| Specification |
|---|
| DOM # eventdef-abortsignal-abort |
| DOM # abortsignal-onabort |
Browser compatibility
Loading…