Utilização

Gives up after five seconds; `reason` says why it stopped.

tsx
// 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

NomeTipoObrigatórioDescrição
prototypesó de leituraAbortSignalSim—
abort(reason?: unknown) => AbortSignalSim—
timeout(milliseconds: number) => AbortSignalSim—
abortedsó de leiturabooleanSim—
reasonsó de leituraunknownSimAn Error named AbortError (or TimeoutError) unless abort was given one.
onabort(event: { type: "abort"; target: AbortSignal;}) => voidSim—
throwIfAborted() => voidSim—
addEventListener(type: "abort", listener: (event: { type: "abort"; target: AbortSignal;}) => void, options?: { once?: boolean;}) => voidSim—
removeEventListener(type: "abort", listener: (event: { type: "abort"; target: AbortSignal;}) => void) => voidSim—
abort — assinaturas de método

Assinaturas

ts
(reason?: unknown): AbortSignal

Parâmetros

NomeTipoObrigatórioDescrição
reasonunknownNão—

Devolve

AbortSignal

timeout — assinaturas de método

Assinaturas

ts
(milliseconds: number): AbortSignal

Parâmetros

NomeTipoObrigatórioDescrição
millisecondsnumberSim—

Devolve

AbortSignal

onabort — assinaturas de método

Assinaturas

ts
(event: { type: "abort"; target: AbortSignal; }): void

Parâmetros

NomeTipoObrigatórioDescrição
event{ type: "abort"; target: AbortSignal;}Sim—

Devolve

void

throwIfAborted — assinaturas de método

Assinaturas

ts
(): void

Parâmetros

Sem parâmetros.

Devolve

void

addEventListener — assinaturas de método

Assinaturas

ts
(type: "abort", listener: (event: { type: "abort"; target: AbortSignal; }) => void, options?: { once?: boolean; }): void

Parâmetros

NomeTipoObrigatórioDescrição
type"abort"Sim—
listener(event: { type: "abort"; target: AbortSignal;}) => voidSim—
options{ once?: boolean;}Não—

Devolve

void

removeEventListener — assinaturas de método

Assinaturas

ts
(type: "abort", listener: (event: { type: "abort"; target: AbortSignal; }) => void): void

Parâmetros

NomeTipoObrigatórioDescrição
type"abort"Sim—
listener(event: { type: "abort"; target: AbortSignal;}) => voidSim—

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.