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

浏览器兼容性

注意: 此 API 基于 Chromium 的 chrome.alarms API。