global.AbortSignal — Kuito Documentation

Utilisation

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;
}

Propriétés et méthodes 9

Nom	Type	Requis	Description
`prototype`lecture seule	`AbortSignal`	Oui	—
`abort`	`(reason?: unknown) => AbortSignal`	Oui	—
`timeout`	`(milliseconds: number) => AbortSignal`	Oui	—
`aborted`lecture seule	`boolean`	Oui	—
`reason`lecture seule	`unknown`	Oui	An Error named `AbortError` (or `TimeoutError`) unless `abort` was given one.
`onabort`	`(event: { type: "abort"; target: AbortSignal;}) => void`	Oui	—
`throwIfAborted`	`() => void`	Oui	—
`addEventListener`	`(type: "abort", listener: (event: { type: "abort"; target: AbortSignal;}) => void, options?: { once?: boolean;}) => void`	Oui	—
`removeEventListener`	`(type: "abort", listener: (event: { type: "abort"; target: AbortSignal;}) => void) => void`	Oui	—

abort — signatures de méthode

Signatures

(reason?: unknown): AbortSignal

Paramètres

Nom	Type	Requis	Description
`reason`	`unknown`	Non	—

Retourne

AbortSignal

timeout — signatures de méthode

Signatures

(milliseconds: number): AbortSignal

Paramètres

Nom	Type	Requis	Description
`milliseconds`	`number`	Oui	—

Retourne

AbortSignal

onabort — signatures de méthode

Signatures

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

Paramètres

Nom	Type	Requis	Description
`event`	`{ type: "abort"; target: AbortSignal;}`	Oui	—

Retourne

void

throwIfAborted — signatures de méthode

Signatures

(): void

Paramètres

Aucun paramètre.

Retourne

void

addEventListener — signatures de méthode

Signatures

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

Paramètres

Nom	Type	Requis	Description
`type`	`"abort"`	Oui	—
`listener`	`(event: { type: "abort"; target: AbortSignal;}) => void`	Oui	—
`options`	`{ once?: boolean;}`	Non	—

Retourne

void

removeEventListener — signatures de méthode

Signatures

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

Paramètres

Nom	Type	Requis	Description
`type`	`"abort"`	Oui	—
`listener`	`(event: { type: "abort"; target: AbortSignal;}) => void`	Oui	—

Retourne

void

Généré depuis les déclarations TypeScript publiques : signatures, props et valeurs par défaut viennent de la source vérifiée, les descriptions de sa JSDoc. Aucune valeur par défaut n'est inventée.