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
name
Optional-
string
. The name of the alarm to get. If you don't supply this, the empty string "" will be used.
Return value
Examples
js
function gotAlarm(alarm) {
if (alarm) {
console.log(alarm.name);
}
}
let getAlarm = browser.alarms.get("my-periodic-alarm");
getAlarm.then(gotAlarm);
Browser compatibility
Report problems with this compatibility data on GitHubdesktop | mobile | ||||||
---|---|---|---|---|---|---|---|
get |
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Note:
This API is based on Chromium's chrome.alarms
API.