downloads.cancel()
The cancel()
function of the 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
js
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
Report problems with this compatibility data on GitHubdesktop | mobile | ||||||
---|---|---|---|---|---|---|---|
cancel |
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- No support
- No support
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Examples
js
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);
Note:
This API is based on Chromium's chrome.downloads
API.