この記事はまだボランティアによって 日本語 に翻訳されていません。ぜひ MDN に参加して翻訳を手伝ってください!
この記事を English (US) で読むこともできます。

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The AbortController interface represents a controller object that allows you to abort one or more DOM requests as and when desired.

You can create a new AbortController object using the AbortController.AbortController() constructor. Communicating with a DOM request is done using an AbortSignal object.

Constructor

AbortController.AbortController()
Creates a new AbortController object instance.

Properties

AbortController.signal Read only
Returns a AbortSignal object instance, which can be used to communicate with/abort a DOM request.

Methods

AbortController.abort()
Aborts a DOM request before it has completed. This is able to abort fetch requests, consumption of any response Body, and streams.

Examples

In the following snippet, we aim to download a video using the Fetch API.

We first create a controller using the AbortController() constructor, then grab a reference to its associated AbortSignal object using the AbortController.signal property.

When the fetch request is initiated, we pass in the AbortSignal as an option inside the request's options object (see {signal}, below). This associates the signal and controller with the fetch request and allows us to abort it by calling AbortController.abort(), as seen below in the second event listener.

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('Download aborted');
});

function fetchVideo() {
  ...
  fetch(url, {signal}).then(function(response) {
    ...
  }).catch(function(e) {
    reports.textContent = 'Download error: ' + e.message;
  })
}

Note: When abort() is called, the fetch() promise rejects with an AbortError.

You can find a full working example on GitHub — see abort-api (see it running live also).

Specifications

Specification Status Comment
DOM
The definition of 'AbortController' in that specification.
Living Standard Initial definition

Browser compatibility

FeatureChromeEdgeFirefoxInternet ExplorerOperaSafari
Basic support661657 No5311.1
AbortController() constructor661657 No5311.1
signal661657 No5311.1
abort661657 No5311.1
FeatureAndroid webviewChrome for AndroidEdge mobileFirefox for AndroidOpera AndroidiOS SafariSamsung Internet
Basic support666616575311.1 No
AbortController() constructor666616575311.1 No
signal666616575311.1 No
abort666616575311.1 No

See also

ドキュメントのタグと貢献者

このページの貢献者: fscholz, chrisdavidmills
最終更新者: fscholz,