global.AbortSignal — Kuito Dokumentation

Verwendung

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

Eigenschaften und Methoden 9

Name	Typ	Erforderlich	Beschreibung
`prototype`schreibgeschützt	`AbortSignal`	Ja	—
`abort`	`(reason?: unknown) => AbortSignal`	Ja	—
`timeout`	`(milliseconds: number) => AbortSignal`	Ja	—
`aborted`schreibgeschützt	`boolean`	Ja	—
`reason`schreibgeschützt	`unknown`	Ja	An Error named `AbortError` (or `TimeoutError`) unless `abort` was given one.
`onabort`	`(event: { type: "abort"; target: AbortSignal;}) => void`	Ja	—
`throwIfAborted`	`() => void`	Ja	—
`addEventListener`	`(type: "abort", listener: (event: { type: "abort"; target: AbortSignal;}) => void, options?: { once?: boolean;}) => void`	Ja	—
`removeEventListener`	`(type: "abort", listener: (event: { type: "abort"; target: AbortSignal;}) => void) => void`	Ja	—

abort — Methodensignaturen

Signaturen

(reason?: unknown): AbortSignal

Parameter

Name	Typ	Erforderlich	Beschreibung
`reason`	`unknown`	Nein	—

Rückgabe

AbortSignal

timeout — Methodensignaturen

Signaturen

(milliseconds: number): AbortSignal

Parameter

Name	Typ	Erforderlich	Beschreibung
`milliseconds`	`number`	Ja	—

Rückgabe

AbortSignal

onabort — Methodensignaturen

Signaturen

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

Parameter

Name	Typ	Erforderlich	Beschreibung
`event`	`{ type: "abort"; target: AbortSignal;}`	Ja	—

Rückgabe

void

throwIfAborted — Methodensignaturen

Signaturen

(): void

Parameter

Keine Parameter.

Rückgabe

void

addEventListener — Methodensignaturen

Signaturen

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

Parameter

Name	Typ	Erforderlich	Beschreibung
`type`	`"abort"`	Ja	—
`listener`	`(event: { type: "abort"; target: AbortSignal;}) => void`	Ja	—
`options`	`{ once?: boolean;}`	Nein	—

Rückgabe

void

removeEventListener — Methodensignaturen

Signaturen

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

Parameter

Name	Typ	Erforderlich	Beschreibung
`type`	`"abort"`	Ja	—
`listener`	`(event: { type: "abort"; target: AbortSignal;}) => void`	Ja	—

Rückgabe

void

Generiert aus den öffentlichen TypeScript-Deklarationen: Signaturen, Props und Standardwerte stammen aus der geprüften Quelle, Beschreibungen aus deren JSDoc. Kein Standardwert ist erfunden.