alarms.clear()
Cancels an alarm, given its name.
This is an asynchronous function that returns a Promise
.
Syntax
let clearAlarm = browser.alarms.clear(
name // string
)
Parameters
name
Optional-
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.
Examples
function onCleared(wasCleared) {
console.log(wasCleared); // true/false
}
let clearAlarm = browser.alarms.clear("my-periodic-alarm");
clearAlarm.then(onCleared);
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.