alarms.clearAll()

Cancels all active alarms.

This is an asynchronous function that returns a Promise.

Syntax

var clearAlarms = browser.alarms.clearAll()

Parameters

None.

Return value

A Promise that will be fulfilled with a boolean. This will be true if any alarms were cleared, false otherwise. Note that Chrome always passes true here.

Examples

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

var clearAlarms = browser.alarms.clearAll();
clearAlarms.then(onClearedAll);

Example extensions

Browser compatibility

BCD tables only load in the browser

Note: 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.