alarms.clear()

Cancels an alarm, given its name.

This is an asynchronous function that returns a Promise.

Syntax

var clearAlarm = browser.alarms.clear(
  name                       // string
)

Parameters

nameOptional

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

Return value

A Promise that will be fulfilled with a boolean. This will be 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

function onCleared(wasCleared) {
  console.log(wasCleared);  // true/false
}
var clearAlarm = browser.alarms.clear("my-periodic-alarm");
clearAlarm.then(onCleared);