Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / JavaScript

AbortController i AbortSignal: żądanie anulowania i odczyt stanu

Przekaż `controller.signal` do operacji obsługującej anulowanie, wywołaj `controller.abort()` i odczytaj `signal.aborted`, aby sprawdzić stan sygnału, a nie wynik operacji.

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

Składnia

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

Utwórz new AbortController() i zachowaj kontroler w kodzie decydującym o anulowaniu. Właściwość instancji controller.signal jest tylko do odczytu i zawsze zwraca ten sam obiekt AbortSignal dla danego kontrolera. Przekaż sygnał do interfejsu API, który go obsługuje, na przykład przez fetch(url, { signal }). Kilka operacji może współdzielić sygnał, jeśli mają wspólny cykl anulowania.

signal.aborted to właściwość logiczna tylko do odczytu, nie metoda. Początkowo ma wartość false. Pierwsze wywołanie controller.abort() lub controller.abort(reason) synchronicznie ustawia stan sygnału na true i emituje zdarzenie abort, zanim wywołanie zwróci undefined. signal.reason zawiera podaną wartość; po pominięciu argumentu lub przekazaniu undefined zawiera DOMException o nazwie AbortError.

Kolejne wywołania nie zmieniają przyczyny ani nie emitują ponownie zdarzenia. Sygnału nie można zresetować: do nowego cyklu anulowania utwórz nowy kontroler. Statyczna metoda AbortSignal.abort() jest czymś innym: tworzy nowy, już anulowany sygnał, zamiast zmieniać sygnał istniejącego kontrolera.

Anulowanie wymaga współpracy operacji. aborted === true opisuje stan sygnału, ale nie potwierdza zatrzymania operacji i nie cofa zakończonej pracy. We własnym API zwracającym Promise sprawdź sygnał przed rozpoczęciem pracy, obsłuż późniejsze zdarzenie abort, odrzuć nadal oczekującą obietnicę z signal.reason i usuń nasłuch po normalnym zakończeniu. To API platformy webowej, a nie część ECMAScript 2024; sprawdź obsługę w docelowym środowisku.

Przykłady

{
  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}`);
}

Wynik

before: false
event: true
after: true, superseded

Wiersz `event: true` pokazuje, że stan został już zmieniony w chwili obsługi zdarzenia. Drugie wywołanie nie emituje kolejnego zdarzenia i nie zastępuje przyczyny `superseded`.

Powiązane lekcje

  • JavaScript · Lekcja 4 · Zaawansowany · Wersja: 4

Źródła