CKTIS / JavaScript
AbortController a AbortSignal: vyžiadanie zrušenia a čítanie stavu
Odovzdaj `controller.signal` operácii, ktorá podporuje zrušenie, vyžiadaj ho cez `controller.abort()` a z `signal.aborted` zisti stav signálu, nie výsledok operácie.
Verzia: ECMAScript 2024 and the current web platform; runtime support varies
Syntax
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);Vytvor ovládač pomocou new AbortController() a ponechaj si ho v kóde, ktorý rozhoduje, kedy operáciu zrušiť. Vlastnosť inštancie controller.signal je len na čítanie a pre daný ovládač vždy vracia ten istý objekt AbortSignal. Odovzdaj ho rozhraniu API, ktoré ho prijíma, napríklad cez fetch(url, { signal }). Viacero operácií môže zdieľať jeden signál, ak sa majú zrušiť spoločne.
signal.aborted je booleovská vlastnosť len na čítanie, nie metóda. Na začiatku má hodnotu false. Prvé volanie controller.abort() alebo controller.abort(reason) synchrónne zmení stav signálu na true a vyvolá udalosť abort skôr, než vráti undefined. signal.reason obsahuje odovzdanú hodnotu; ak argument vynecháš alebo odovzdáš undefined, obsahuje DOMException s názvom AbortError.
Ďalšie volania nezmenia dôvod ani nevyvolajú ďalšiu udalosť. Signál nemožno vrátiť do počiatočného stavu: pre nový cyklus rušenia vytvor nový ovládač. Statická metóda AbortSignal.abort() funguje inak: vytvorí nový, už zrušený signál namiesto zmeny signálu existujúceho ovládača.
Zrušenie vyžaduje spoluprácu operácie. aborted === true opisuje stav signálu: nepotvrdzuje, že sa operácia zastavila, ani nevracia späť dokončenú prácu. Vo vlastnom API založenom na prísľuboch skontroluj signál pred začiatkom práce, ošetri neskoršiu udalosť abort, ešte nevybavený prísľub zamietni s hodnotou signal.reason a pri bežnom dokončení odstráň poslucháča. Ide o API webovej platformy, nie o súčasť ECMAScriptu 2024; over podporu v cieľovom prostredí.
Prí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ýsledok
before: false event: true after: true, superseded
Riadok `event: true` ukazuje, že pri spustení poslucháča je stav už zmenený. Druhé volanie nevyvolá ďalšiu udalosť ani nenahradí dôvod `superseded`.
Súvisiace lekcie
- JavaScript · Lekcia 4 · Pokročilá · Verzia: 4