index.md

---

title: downloads.cancel()
slug: Mozilla/Add-ons/WebExtensions/API/downloads/cancel
page-type: webextension-api-function
tags:
  - API
  - Add-ons
  - Extensions
  - Method
  - Non-standard
  - Reference
  - WebExtensions
  - cancel
  - downloads
browser-compat: webextensions.api.downloads.cancel

---

{{AddonSidebar()}}

The cancel() function of the {{WebExtAPIRef("downloads")}} API cancels a download. The call will fail if the download is not active: for example, because it has completed downloading.

This is an asynchronous function that returns a Promise.

Syntax

let canceling = browser.downloads.cancel(
  downloadId      // integer
)

Parameters

• downloadId

  • : integer. The id of the download to cancel.

Return value

A Promise. If the request was successful, the promise will be fulfilled with no arguments. If the request failed, the promise will be rejected with an error message.

Browser compatibility

{{Compat}}

Examples

let downloadId = 13;

function onCanceled() {
  console.log(`Canceled download`);
}

function onError(error) {
  console.log(`Error: ${error}`);
}

let canceling = browser.downloads.cancel(downloadId);
canceling.then(onCanceled, onError);

{{WebExtExamples}}

Note: This API is based on Chromium's chrome.downloads API.