alarms.get()

获取指定名称的闹钟。

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

语法

js
let getAlarm = browser.alarms.get(
  name                   // 可选字符串
)

参数

name 可选

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

返回值

一个 Promise，其会兑现一个 Alarm 对象。这代表了名称与 name 匹配的闹钟。如果没有匹配的闹钟，则为 undefined。

示例

js
function gotAlarm(alarm) {
  if (alarm) {
    console.log(alarm.name);
  }
}

let getAlarm = browser.alarms.get("my-periodic-alarm");
getAlarm.then(gotAlarm);

浏览器兼容性

BCD tables only load in the browser

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