alarms.get()
Gets an alarm, given its name.
This is an asynchronous function that returns a Promise.
Syntax
js
let getAlarm = browser.alarms.get(
name // optional string
)
Parameters
nameOptional-
string. The name of the alarm to get. If you don't supply this, the empty string "" will be used.
Return value
A Promise that will be fulfilled with an Alarm object. This represents the alarm whose name matches name. If no alarms match, this will be undefined.
Examples
js
function gotAlarm(alarm) {
if (alarm) {
console.log(alarm.name);
}
}
let getAlarm = browser.alarms.get("my-periodic-alarm");
getAlarm.then(gotAlarm);
Browser compatibility
| desktop | mobile | ||||||
|---|---|---|---|---|---|---|---|
get
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
Note:
This API is based on Chromium's chrome.alarms API.