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.
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.
Chrome | Edge | Firefox | Firefox for Android | Opera | |
---|---|---|---|---|---|
Basic support | Yes | No | 45 | 48 | Yes |
Examples
function onClearedAll(wasCleared) { console.log(wasCleared); // true/false } var clearAlarms = browser.alarms.clearAll(); clearAlarms.then(onClearedAll);
Example extensions
Acknowledgements
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.