CKTIS / JavaScript
AbortController и AbortSignal: заявка за отмяна и проверка на състоянието
Подай `controller.signal` на операция, която поддържа отмяна, заяви я с `controller.abort()` и прочети `signal.aborted`, за да провериш състоянието на сигнала, а не резултата от операцията.
Версия: ECMAScript 2024 and the current web platform; runtime support varies
Синтаксис
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);Създай контролер с new AbortController() и го запази в кода, който решава кога да поиска отмяна. Свойството на екземпляра controller.signal е само за четене и за дадения контролер винаги връща един и същ обект AbortSignal. Подай го на API, който го приема, например чрез fetch(url, { signal }). Няколко операции могат да споделят един сигнал, ако трябва да бъдат отменени заедно.
signal.aborted е булево свойство само за четене, а не метод. Първоначално стойността му е false. Първото извикване на controller.abort() или controller.abort(reason) синхронно променя състоянието на сигнала на true и задейства събитието abort, преди да върне undefined. signal.reason съдържа подадената стойност; ако аргументът е пропуснат или е undefined, съдържа DOMException с име AbortError.
Следващите извиквания не заменят причината и не задействат ново събитие. Сигналът не може да се върне в начално състояние: създай нов контролер за нов цикъл на отмяна. Статичният метод AbortSignal.abort() работи различно: създава нов, вече отменен сигнал, вместо да променя сигнала на съществуващ контролер.
Отмяната изисква съдействие от самата операция. aborted === true описва състоянието на сигнала: не потвърждава, че операцията е спряла, и не отменя вече свършената работа. В собствен API, базиран на обещания, провери сигнала преди старта, обработи по-късно събитие abort, отхвърли все още чакащото обещание със signal.reason и премахни слушателя при нормално приключване. Това са API на уеб платформата, а не част от ECMAScript 2024; провери поддръжката в целевата среда за изпълнение.
Примери
{
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}`);
}Резултат
before: false event: true after: true, superseded
Редът `event: true` показва, че състоянието вече е променено, когато слушателят се изпълни. Второто извикване не задейства ново събитие и не заменя причината `superseded`.
Свързани уроци
- JavaScript · Урок 4 · Напреднало · Версия: 4