--- title: AbortController.signal slug: Web/API/AbortController/signal translation_of: Web/API/AbortController/signal ---
{{APIRef("DOM")}}{{SeeCompatTable}}
Примечание: Это свойство только для чтения.
Свойство signal
интерфейса {{domxref("AbortController")}} возвращает экземпляр объекта {{domxref("AbortSignal")}}, который может быть использован для связи/прерывания DOM запроса по желанию.
var signal = abortController.signal;
Экземпляр объекта {{domxref("AbortSignal")}}.
В следующем фрагменте мы будем загружать видео используя Fetch API.
Сначала мы создаём контроллер с помощью конструктора {{domxref("AbortController.AbortController","AbortController()")}}, а затем получаем ссылку на связанный объект {{domxref("AbortSignal")}} используя свойство {{domxref("AbortController.signal")}}.
Когда fetch запрос инициируется, мы передаём AbortSignal
в качестве опции внутрь объекта параметров запроса (см. {signal}
ниже). Это связывает сигнал и контроллер с fetch запросом и позволяет нам прервать его, вызвав {{domxref("AbortController.abort()")}}, как показано ниже во втором обработчике событий.
var controller = new AbortController(); var signal = controller.signal; var downloadBtn = document.querySelector('.download'); var abortBtn = document.querySelector('.abort'); downloadBtn.addEventListener('click', fetchVideo); abortBtn.addEventListener('click', function() { controller.abort(); console.log('Загрузка прервана'); }); function fetchVideo() { ... fetch(url, {signal}).then(function(response) { ... }).catch(function(e) { reports.textContent = 'Ошибка загрузки: ' + e.message; }) }
Примечание: Когда abort()
вызывается, промис fetch()
отклоняется с AbortError
.
Вы можете найти полный рабочий пример на GitHub — см. abort-api (см. как он работает в живую).
Спецификация | Статус | Комментарий |
---|---|---|
{{SpecName('DOM WHATWG', '#dom-abortcontroller-signal', 'signal')}} | {{Spec2('DOM WHATWG')}} | Initial definition |
{{Compat("api.AbortController.signal")}}