Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ browser.alarms.create(
- : `double`. The time the alarm will fire first, given as minutes from the time the alarm is set. If you specify `delayInMinutes`, don't specify `when`.
- `periodInMinutes` {{optional_inline}}
- : `double`. If this is specified, the alarm will fire again every `periodInMinutes` after its initial firing. If you specify this value you may omit both `when` and `delayInMinutes`, and the alarm will then fire initially after `periodInMinutes`. If `periodInMinutes` is not specified, the alarm will only fire once.
- `persistAcrossSessions` {{optional_inline}}
- : `boolean`. Whether alarm should persist across (profile) browsing sessions. Set this to `true` to persist alarm until the extension updates. Set to `false` to clear alarm when the extension is reloaded or updated or the browser restarts. If browser does not support profiles, then browsing session lasts from the moment the first browsing window opens until the last one closes. If browser supports profiles, then closing all windows belonging to the same (non-incognito) profile will terminate the profile browsing session, even if another profile has an active browsing session. As of September 2026, only Chrome 150+ supports this attribute, but other browsers may implement it later. In Chrome, this attribute defaults to `true` to match prior behavior. Other browsers, namely Firefox, may implement this attribute with default value of `false` to match current behavior (Firefox clears alarms across sessions). See [this discussion](https://github.com/w3c/webextensions/issues/406) for details.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This paragraph is a bit heavy with technical details, but I don't think I can cut anything out. In particular, it should mention that (1) only Chromium supports this key, (2) non-persistent alarms get cleared when profile gets closed (even if a browser is open with a different profile), (3) browsers have different defaults.


### Return value

Expand Down
Loading