alarms.clearAll()

Cancels all active alarms.

This is an asynchronous function that returns a Promise.

Syntax

let 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
}

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

{{WebExtExamples}}

Browser compatibility

{{Compat}}

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