Znalostní bázeCentrum zkoušek
CSČeština
Vybrat jazyk13

CKTIS / JavaScript

AbortController a AbortSignal: vyžádání zrušení a čtení stavu

Předej `controller.signal` operaci, která podporuje zrušení, vyžádej ho pomocí `controller.abort()` a z `signal.aborted` zjisti stav signálu, nikoli výsledek operace.

Verze: ECMAScript 2024 and the current web platform; runtime support varies

Syntaxe

const controller = new AbortController();
const signal = controller.signal;
const aborted = signal.aborted;

// Two call forms; choose one for the first abort:
controller.abort();
controller.abort(reason);

Vytvoř řadič pomocí new AbortController() a ponech si ho v kódu, který rozhoduje, kdy operaci zrušit. Vlastnost instance controller.signal je jen pro čtení a pro daný řadič vždy vrací stejný objekt AbortSignal. Předej ho API, které ho přijímá, například pomocí fetch(url, { signal }). Více operací může sdílet jeden signál, pokud mají být zrušeny společně.

signal.aborted je logická vlastnost jen pro čtení, nikoli metoda. Na začátku má hodnotu false. První volání controller.abort() nebo controller.abort(reason) synchronně změní stav signálu na true a vyvolá událost abort, než vrátí undefined. signal.reason obsahuje předanou hodnotu; pokud argument vynecháš nebo předáš undefined, obsahuje DOMException s názvem AbortError.

Další volání nezmění důvod ani nevyvolají další událost. Signál nelze vrátit do výchozího stavu: pro nový cyklus rušení vytvoř nový řadič. Statická metoda AbortSignal.abort() funguje jinak: vytvoří nový, již zrušený signál, místo aby změnila signál existujícího řadiče.

Zrušení vyžaduje spolupráci operace. aborted === true popisuje stav signálu: nepotvrzuje, že se operace zastavila, ani nevrací zpět hotovou práci. Ve vlastním API založeném na příslibech zkontroluj signál před zahájením práce, ošetři pozdější událost abort, dosud nevyřízený příslib zamítni s hodnotou signal.reason a při běžném dokončení odeber posluchač. Jde o API webové platformy, nikoli o součást ECMAScriptu 2024; ověř podporu v cílovém prostředí.

Příklady

{
  const controller = new AbortController();
  const signal = controller.signal;

  console.log(`before: ${signal.aborted}`);
  signal.addEventListener("abort", () => {
    console.log(`event: ${signal.aborted}`);
  });

  controller.abort("superseded");
  controller.abort("ignored");
  console.log(`after: ${signal.aborted}, ${signal.reason}`);
}

Výsledek

before: false
event: true
after: true, superseded

Řádek `event: true` ukazuje, že při spuštění posluchače už je stav změněný. Druhé volání nevyvolá další událost ani nenahradí důvod `superseded`.

Související lekce

  • JavaScript · Lekce 4 · Pokročilá · Verze: 4

Zdroje