Docs4dev
Docs
web_extensions / latest / api / alarms / clearall.html

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);

Example extensions

Browser compatibility

Desktop Mobile
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
clearAll Yes 79 45 ? Yes 14 ? ? 48 ? 15 ?

Note: This API is based on Chromium's chrome.alarms API.

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/alarms/clearAll