alarms.clear()

取消指定名称的闹钟。

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

语法

js
let clearAlarm = browser.alarms.clear(
  name                       // string
)

参数

name 可选

string。要清除的闹钟的名称。如果未提供此参数，将使用空字符串 ""。

返回值

一个 Promise，其会兑现一个布尔值。如果闹钟被清除，则为 true，否则为 false。

示例

js
function onCleared(wasCleared) {
  console.log(wasCleared); // true/false
}

let clearAlarm = browser.alarms.clear("my-periodic-alarm");
clearAlarm.then(onCleared);

浏览器兼容性

BCD tables only load in the browser

备注： 此 API 基于 Chromium 的 chrome.alarms API。