downloads.cancel()

cancel() 是 downloads API 的一个函数，用于取消下载。如果下载未处于活动状态（例如，已完成下载），则调用将失败。

这是一个返回 Promise 的异步函数。

语法

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

参数

downloadId

integer. 要取消下载的下载 ID。

返回值

A Promise. 如果请求成功，则 promise 将在没有参数的情况下完成。如果请求失败，则 promise 将被拒绝并显示错误消息。

浏览器兼容性

BCD 表格仅在浏览器中加载

示例

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);

注意： 此 API 基于 Chromium 的 chrome.downloads API。