AbortController.abort(), signal.throwIfAborted(), AbortSignal.abort()
new AbortController()
AbortController.prototype.abort(reason)
AbortSignal.prototype.throwIfAborted()
AbortSignal.abort(reason)Abort a signal with a reason, throw if it is already aborted, or create an already aborted signal.
| Parameter | Description |
|---|---|
reason | An optional value stored on signal.reason and thrown by throwIfAborted. If omitted, Node.js 22.23.3 uses a DOMException named AbortError. |
Returns: abort returns undefined. AbortSignal.abort returns an aborted AbortSignal.
Throws
signal.reason— throwIfAborted throws the stored reason. After abort("stop") this was the string "stop". After abort() with no argument it was a DOMException named AbortError.
- Listeners are notified when the signal first becomes aborted. A later abort call does not fire them again in this measurement.
const controller = new AbortController();
console.log(controller.signal.aborted);
console.log(controller.signal.reason);
controller.abort("stop");
console.log(controller.signal.aborted);
console.log(controller.signal.reason);
try {
controller.signal.throwIfAborted();
} catch (error) {
console.log(typeof error, error);
}
const already = AbortSignal.abort("done");
console.log(already.aborted, already.reason);
const once = new AbortController();
let count = 0;
once.signal.addEventListener("abort", () => {
count += 1;
});
once.abort("first");
once.abort("second");
console.log(count, once.signal.reason);
const fallback = new AbortController();
fallback.abort();
try {
fallback.signal.throwIfAborted();
} catch (error) {
console.log(error.name);
}
Expected output
false
undefined
true
stop
string stop
true done
1 first
AbortError
Related: Request and Response