alarms.clear()
Cancels an alarm, given its name.
This is an asynchronous function that returns a Promise
.
Syntax
js
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
js
function onCleared(wasCleared) {
console.log(wasCleared); // true/false
}
let clearAlarm = browser.alarms.clear("my-periodic-alarm");
clearAlarm.then(onCleared);
Browser compatibility
Report problems with this compatibility data on GitHubdesktop | mobile | ||||||
---|---|---|---|---|---|---|---|
clear |
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
The compatibility table on 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.
Note:
This API is based on Chromium's chrome.alarms
API.