Docs4dev
Docs
web_extensions / latest / api / alarms / get.html

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

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

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

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

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
get Yes 79 45 ? Yes 14 ? ? 48 ? 15 ?

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

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/alarms/get