AbortSignal: any() static method
Baseline 2024
Newly available
Since March 2024, this feature works across the latest devices and browser versions. This feature might not work in older devices or browsers.
Note: This feature is available in Web Workers.
The AbortSignal.any()
static method takes an iterable of abort signals and returns an AbortSignal
. The returned abort signal is aborted when any of the input iterable abort signals are aborted. The abort reason will be set to the reason of the first signal that is aborted. If any of the given abort signals are already aborted then so will be the returned AbortSignal
.
Syntax
js
AbortSignal.any(iterable)
Parameters
Return value
A AbortSignal
that is:
- Already aborted, if any of the abort signals given is already aborted. The returned
AbortSignal
's reason will be already set to thereason
of the first abort signal that was already aborted. - Asynchronously aborted, when any abort signal in
iterable
aborts. Thereason
will be set to the reason of the first abort signal that is aborted.
Examples
Using AbortSignal.any()
This example demonstrates combining both a signal from an AbortController
, and a timeout signal from AbortSignal.timeout
.
js
const cancelDownloadButton = document.getElementById("cancelDownloadButton");
const userCancelController = new AbortController();
cancelDownloadButton.addEventListener("click", () => {
userCancelController.abort();
});
// Timeout after 5 minutes
const timeoutSignal = AbortSignal.timeout(1_000 * 60 * 5);
// This signal will abort when either the user clicks the cancel button or 5 minutes is up
// whichever is sooner
const combinedSignal = AbortSignal.any([
userCancelController.signal,
timeoutSignal,
]);
try {
const res = await fetch(someUrlToDownload, {
// Stop the fetch when any of the signals aborts
signal: combinedSignal,
});
const body = await res.blob();
// Do something with downloaded content:
// ...
} catch (e) {
if (e.name === "AbortError") {
// Cancelled by the user
} else if (e.name === "TimeoutError") {
// Show user that download timed out
} else {
// Other error, e.g. network error
}
}
Specifications
Specification |
---|
DOM Standard # dom-abortsignal-any |
Browser compatibility
BCD tables only load in the browser