alarms.get()

Gets an alarm, given its name.

This is an asynchronous function that returns a Promise.

Syntax

let getAlarm = browser.alarms.get(
  name                   // optional string
)

Parameters

• name {{optional_inline}}
  • : 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 {{WebExtAPIRef('alarms.Alarm', "Alarm")}} object. This represents the alarm whose name matches name. If no alarms match, this will be undefined.

Examples

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

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

{{WebExtExamples}}

Browser compatibility

{{Compat}}

[!NOTE] This API is based on Chromium's chrome.alarms API.