AbortSignal: throwIfAborted() method
Baseline
Widely available
This feature is well established and works across many devices and browser versions. It’s been available across browsers since April 2022.
Note: This feature is available in Web Workers.
The throwIfAborted() method throws the signal's abort reason if the signal has been aborted; otherwise it does nothing.
An API that needs to support aborting can accept an AbortSignal object and use throwIfAborted() to test and throw when the abort event is signalled.
This method can also be used to abort operations at particular points in code, rather than passing to functions that take a signal.
Syntax
throwIfAborted()
Parameters
None.
Return value
None (undefined).
Examples
The examples below come from the specification.
Aborting a polling operation
This example demonstrates how you can use throwIfAborted() to abort a polling operation.
Consider an asynchronous waitForCondition() function that is called with another asynchronous function func, a target value targetValue, and an AbortSignal.
The method compares the result of func with targetValue in a loop, returning when they match.
async function waitForCondition(func, targetValue, { signal } = {}) {
while (true) {
signal?.throwIfAborted();
const result = await func();
if (result === targetValue) {
return;
}
}
}
On each iteration of the loop, we use throwIfAborted() to throw the signal's reason if the operation has been aborted (and otherwise do nothing).
If the signal is aborted, this will cause the waitForCondition() promise to be rejected.
Specifications
| Specification |
|---|
| DOM # ref-for-dom-abortsignal-throwifaborted① |
Browser compatibility
| desktop | mobile | server | |||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
throwIfAborted
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- Has more compatibility info.