Mozilla's getting a new look. What do you think? https://mzl.la/brandsurvey

alarms.get()

Gets an alarm, given its name. The alarm is passed into a callback function as an alarms.Alarm object.

Syntax

chrome.alarms.get(
  name,                   // optional string
  function(alarm) {...}   // function
)

This API is also available as browser.alarms.get() in a version that returns a promise.

Parameters

nameOptional
string. The name of the alarm to get. If you don't supply this, the empty string "" will be used.
callback
function. The function is passed the following arguments:
alarm
alarms.Alarm. The alarm whose name matches name. If no alarms match, this will be undefined.

Browser compatibility

Chrome Edge Firefox Firefox for Android Opera
Basic support Yes No 45.0 48.0 33

Examples

Callback-based version:

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

chrome.alarms.get("my-periodic-alarm", gotAlarm);

Promise-based version:

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

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

Acknowledgements

This API is based on Chromium's chrome.alarms API.

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

Document Tags and Contributors

 Contributors to this page: Makyen, wbamberg
 Last updated by: Makyen,