--- title: AbortSignal slug: Web/API/AbortSignal translation_of: Web/API/AbortSignal ---
{{APIRef("DOM")}}{{SeeCompatTable}}

AbortSignal интерфейс представляет собой объект сигнала, который позволяет вам общаться с DOM запросом (например, Fetch) и прервать его при необходимости с помощью объекта {{domxref("AbortController")}}.

Свойства

AbortSignal также наследует свойства от своего родительского интерфейса, {{domxref("EventTarget")}}.

{{domxref("AbortSignal.aborted")}} {{readonlyInline}}
Это {{domxref("Boolean")}}, который указывает, отменён ли запрос(ы), с которым связывался сигнал, отменён (true) или нет (false).

Обработчики событий

{{domxref("AbortSignal.onabort")}}
Вызывается когда происходит событие {{event("abort_(dom_abort_api)", "abort")}}, т.е. когда DOM запрос(ы), с которым связывался сигнал, отменён.

Методы

AbortSignal наследует методы от родительского интерфейса, {{domxref("EventTarget")}}.

Примеры

В следующем фрагменте мы будем загружать видео используя 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.

Текущая версия Firefox отклоняет обещание с DOMException

Вы можете найти полный рабочий пример на GitHub — см. abort-api (см. как он работает в живую).

Спецификации

Спецификация Статус Комментарий
{{SpecName('DOM WHATWG', '#interface-AbortSignal', 'AbortSignal')}} {{Spec2('DOM WHATWG')}} Initial definition

Совместимость с браузерами

{{Compat("api.AbortSignal")}}

Смотрите также