Baza znanjaIzpitno središče
SLSlovenščina
Izberi jezik13

CKTIS / JavaScript

AbortController in AbortSignal: zahteva za preklic in branje stanja

Posreduj `controller.signal` operaciji, ki podpira preklic, zahtevaj ga z `controller.abort()` in iz `signal.aborted` preberi stanje signala, ne izida operacije.

Različica: ECMAScript 2024 and the current web platform; runtime support varies

Sintaksa

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

Ustvari krmilnik z new AbortController() in ga obdrži v kodi, ki odloča, kdaj zahtevati preklic. Lastnost primerka controller.signal je samo za branje in za dani krmilnik vedno vrne isti objekt AbortSignal. Posreduj ga vmesniku API, ki ga sprejema, na primer z fetch(url, { signal }). Več operacij si lahko deli en signal, če jih želiš preklicati skupaj.

signal.aborted je logična lastnost samo za branje, ne metoda. Sprva ima vrednost false. Prvi klic controller.abort() ali controller.abort(reason) sinhrono spremeni stanje signala v true in sproži dogodek abort, preden vrne undefined. signal.reason vsebuje podano vrednost; če argument izpustiš ali podaš undefined, vsebuje DOMException z imenom AbortError.

Poznejši klici ne zamenjajo razloga in ne sprožijo novega dogodka. Signala ni mogoče ponastaviti: za nov cikel preklica ustvari nov krmilnik. Statična metoda AbortSignal.abort() deluje drugače: ustvari nov, že preklican signal, namesto da bi spremenila signal obstoječega krmilnika.

Preklic zahteva sodelovanje operacije. aborted === true opisuje stanje signala: ne potrjuje, da se je operacija ustavila, in ne razveljavi opravljenega dela. V svojem API-ju, ki temelji na obljubah, pred začetkom preveri signal, obravnavaj poznejši dogodek abort, zavrni še čakajočo obljubo z vrednostjo signal.reason in ob običajnem zaključku odstrani poslušalca. To so vmesniki spletne platforme, ne del ECMAScripta 2024; preveri podporo v ciljnem izvajalnem okolju.

Primeri

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

Rezultat

before: false
event: true
after: true, superseded

Vrstica `event: true` pokaže, da se je stanje že spremenilo, ko se izvede poslušalec. Drugi klic ne sproži novega dogodka in ne zamenja razloga `superseded`.

Povezane lekcije

  • JavaScript · Lekcija 4 · Napredna · Različica: 4

Viri