index.md

---

title: AbortController.abort()
slug: Web/API/AbortController/abort
page-type: web-api-instance-method
browser-compat: api.AbortController.abort

---

{{APIRef("DOM")}}

The abort() method of the {{domxref("AbortController")}} interface aborts a DOM request before it has completed. This is able to abort fetch requests, the consumption of any response bodies, or streams.

Syntax

abort()
abort(reason)

Parameters

• reason {{optional_inline}}

  • : The reason why the operation was aborted, which can be any JavaScript value. If not specified, the reason is set to "AbortError" {{domxref("DOMException")}}.

Return value

None ({{jsxref("undefined")}}).

Examples

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

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

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

const controller = new AbortController();
const signal = controller.signal;

const url = "video.mp4";
const downloadBtn = document.querySelector(".download");
const abortBtn = document.querySelector(".abort");

downloadBtn.addEventListener("click", fetchVideo);

abortBtn.addEventListener("click", () => {
  controller.abort();
  console.log("Download aborted");
});

function fetchVideo() {
  fetch(url, { signal })
    .then((response) => {
      console.log("Download complete", response);
    })
    .catch((err) => {
      console.error(`Download error: ${err.message}`);
    });
}

Note: When abort() is called, the fetch() promise rejects with an Error of type DOMException, with name AbortError.

You can find a full working example on GitHub; you can also see it running live.

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• Fetch API