alarms.clear()

Cancels an alarm, given its name.

Syntax

chrome.alarms.clear(
  name,                        // string
  function(wasCleared) {...}   // function
)

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

Parameters

nameOptional

string. The name of the alarm to clear. If you don't supply this, the empty string "" will be used.

callbackOptional

function. The function is passed the following arguments:

wasCleared

boolean. true if the alarm was cleared, false otherwise.

Browser compatibility

The compatibility table in 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.

Examples

Callback-based version:

function onCleared(wasCleared) {
  console.log(wasCleared); // true/false
}

chrome.alarms.clear("my-periodic-alarm", onCleared);

Promise-based version:

function onCleared(wasCleared) {
  console.log(wasCleared);  // true/false
}

var clearAlarm = browser.alarms.clear("my-periodic-alarm");
clearAlarm.then(onCleared);