global.AbortSignal
Cancels a fetch or other work it is given to; AbortSignal.timeout() makes one that fires after a delay.
Utilização
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;
}Propriedades e métodos 9
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
prototypesó de leitura | AbortSignal | Sim | — |
abort | (reason?: unknown) => AbortSignal | Sim | — |
timeout | (milliseconds: number) => AbortSignal | Sim | — |
abortedsó de leitura | boolean | Sim | — |
reasonsó de leitura | unknown | Sim | An Error named AbortError (or TimeoutError) unless abort was given one. |
onabort | (event: { type: "abort"; target: AbortSignal;}) => void | Sim | — |
throwIfAborted | () => void | Sim | — |
addEventListener | (type: "abort", listener: (event: { type: "abort"; target: AbortSignal;}) => void, options?: { once?: boolean;}) => void | Sim | — |
removeEventListener | (type: "abort", listener: (event: { type: "abort"; target: AbortSignal;}) => void) => void | Sim | — |
abort — assinaturas de método
Assinaturas
(reason?: unknown): AbortSignalParâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
reason | unknown | Não | — |
Devolve
AbortSignal
timeout — assinaturas de método
Assinaturas
(milliseconds: number): AbortSignalParâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
milliseconds | number | Sim | — |
Devolve
AbortSignal
onabort — assinaturas de método
Assinaturas
(event: { type: "abort"; target: AbortSignal; }): voidParâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
event | { type: "abort"; target: AbortSignal;} | Sim | — |
Devolve
void
throwIfAborted — assinaturas de método
Assinaturas
(): voidParâmetros
Sem parâmetros.
Devolve
void
addEventListener — assinaturas de método
Assinaturas
(type: "abort", listener: (event: { type: "abort"; target: AbortSignal; }) => void, options?: { once?: boolean; }): voidParâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
type | "abort" | Sim | — |
listener | (event: { type: "abort"; target: AbortSignal;}) => void | Sim | — |
options | { once?: boolean;} | Não | — |
Devolve
void
removeEventListener — assinaturas de método
Assinaturas
(type: "abort", listener: (event: { type: "abort"; target: AbortSignal; }) => void): voidParâmetros
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
type | "abort" | Sim | — |
listener | (event: { type: "abort"; target: AbortSignal;}) => void | Sim | — |
Devolve
void
Gerado a partir das declarações TypeScript públicas: assinaturas, props e predefinições vêm da fonte verificada, as descrições da sua JSDoc. Nenhuma predefinição é inventada.