global.AbortSignal
Cancels a fetch or other work it is given to; AbortSignal.timeout() makes one that fires after a delay.
Usage
Gives up after five seconds; `reason` says why it stopped.
// Gives up after five seconds; `reason` says why it stopped.
const signal = AbortSignal.timeout(5000);
try {
const response = await fetch('https://api.example.com/items', { signal });
console.log(await response.json());
} catch (error) {
if (signal.aborted) console.log('Timed out:', signal.reason);
else throw error;
}Properties and methods 9
| Name | Type | Required | Description |
|---|---|---|---|
prototypereadonly | AbortSignal | Yes | — |
abort | (reason?: unknown) => AbortSignal | Yes | — |
timeout | (milliseconds: number) => AbortSignal | Yes | — |
abortedreadonly | boolean | Yes | — |
reasonreadonly | unknown | Yes | An Error named AbortError (or TimeoutError) unless abort was given one. |
onabort | (event: { type: "abort"; target: AbortSignal;}) => void | Yes | — |
throwIfAborted | () => void | Yes | — |
addEventListener | (type: "abort", listener: (event: { type: "abort"; target: AbortSignal;}) => void, options?: { once?: boolean;}) => void | Yes | — |
removeEventListener | (type: "abort", listener: (event: { type: "abort"; target: AbortSignal;}) => void) => void | Yes | — |
abort — method signatures
Signatures
(reason?: unknown): AbortSignalParameters
| Name | Type | Required | Description |
|---|---|---|---|
reason | unknown | No | — |
Returns
AbortSignal
timeout — method signatures
Signatures
(milliseconds: number): AbortSignalParameters
| Name | Type | Required | Description |
|---|---|---|---|
milliseconds | number | Yes | — |
Returns
AbortSignal
onabort — method signatures
Signatures
(event: { type: "abort"; target: AbortSignal; }): voidParameters
| Name | Type | Required | Description |
|---|---|---|---|
event | { type: "abort"; target: AbortSignal;} | Yes | — |
Returns
void
throwIfAborted — method signatures
Signatures
(): voidParameters
No parameters.
Returns
void
addEventListener — method signatures
Signatures
(type: "abort", listener: (event: { type: "abort"; target: AbortSignal; }) => void, options?: { once?: boolean; }): voidParameters
| Name | Type | Required | Description |
|---|---|---|---|
type | "abort" | Yes | — |
listener | (event: { type: "abort"; target: AbortSignal;}) => void | Yes | — |
options | { once?: boolean;} | No | — |
Returns
void
removeEventListener — method signatures
Signatures
(type: "abort", listener: (event: { type: "abort"; target: AbortSignal; }) => void): voidParameters
| Name | Type | Required | Description |
|---|---|---|---|
type | "abort" | Yes | — |
listener | (event: { type: "abort"; target: AbortSignal;}) => void | Yes | — |
Returns
void
Generated from the public TypeScript declarations: signatures, props and defaults come from the checked source, descriptions from its JSDoc. No defaults are invented.