Fix several issues in webext storage docs#43924
Merged
Conversation
storage/onchanged: - Mention storage.StorageArea.onChanged in storage.onChanged. - Change "return" terminology to "listener" / "receive" in onChanged. - Add missing "session" to storage.onChanged's areaName parameter. - Include mention of `storage.managed` behavior that was already mentioned in the storage.StorageArea.onChanged docs. storage/storagearea: - Clarify that `StorageArea` is an abstract type and explicitly mention the concrete APIs it applies to. storage/onchanged: - Change "return" terminology to "listener" / "receive" in onChanged. - Fix very confusing description of managed storage. storage/setaccesslevel: - Drop mention of it supporting session only. It expanded to all storage areas in Chrome 140 (https://issues.chromium.org/issues/40949182). storage/storagechange: - Mention the events this type relates to.
github-actions
Bot
added
Content:WebExt
Contributor
|
Preview URLs (5 pages)
External URLs (4)URL:
URL:
(comment last updated: 2026-04-29 23:29:44) |
rebloor
reviewed
Apr 26, 2026
Comment on lines
+11
to
+13
| Unlike other storage areas, `storage.session` is only available to privileged (trusted) extension contexts. This `setAccessLevel` method is used to expose the session storage area to content scripts too. | ||
|
|
||
| Unlike other storage areas, `storage.session` is only available to privileged (trusted) extension contexts. This `setAccessLevel` method is used to expose the session storage area to content scripts too. By default, all other storage areas are exposed to all extension contexts, including content scripts. | ||
| By default, all other storage areas are exposed to all extension contexts, including content scripts. This `setAccessLevel` method can be used to restrict access of these storage areas in content scripts. |
Contributor
There was a problem hiding this comment.
Suggested change
| Unlike other storage areas, `storage.session` is only available to privileged (trusted) extension contexts. This `setAccessLevel` method is used to expose the session storage area to content scripts too. | |
| Unlike other storage areas, `storage.session` is only available to privileged (trusted) extension contexts. This `setAccessLevel` method is used to expose the session storage area to content scripts too. By default, all other storage areas are exposed to all extension contexts, including content scripts. | |
| By default, all other storage areas are exposed to all extension contexts, including content scripts. This `setAccessLevel` method can be used to restrict access of these storage areas in content scripts. | |
| Use this method to: | |
| - Expose the `session` storage area to content scripts. Unlike other storage areas, `storage.session` is only available to privileged (trusted) extension contexts. | |
| - Restrict content scripts' access to `local`, `managed`, and `sync` storage areas. By default, these storage areas are exposed to all extension contexts, including content scripts. |
Member
Author
There was a problem hiding this comment.
Added "by default" to your suggested description for session.
Suggested change
| Unlike other storage areas, `storage.session` is only available to privileged (trusted) extension contexts. This `setAccessLevel` method is used to expose the session storage area to content scripts too. | |
| Unlike other storage areas, `storage.session` is only available to privileged (trusted) extension contexts. This `setAccessLevel` method is used to expose the session storage area to content scripts too. By default, all other storage areas are exposed to all extension contexts, including content scripts. | |
| By default, all other storage areas are exposed to all extension contexts, including content scripts. This `setAccessLevel` method can be used to restrict access of these storage areas in content scripts. | |
| Use this method to: | |
| - Expose the `session` storage area to content scripts. Unlike other storage areas, `storage.session` is only available to privileged (trusted) extension contexts by default. | |
| - Restrict content scripts' access to `local`, `managed`, and `sync` storage areas. By default, these storage areas are exposed to all extension contexts, including content scripts. |
Co-authored-by: rebloor <git@sherpa.co.nz>
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
…d/index.md Co-authored-by: rebloor <git@sherpa.co.nz>
Rob--W
commented
Apr 29, 2026
Member
Author
Rob--W
left a comment
Rob--W
left a comment
There was a problem hiding this comment.
I thumbed up the remaining review comments. The one remaining question is what to do with "line 13". To duplicate it in the other doc, or to remove it altogether?
rebloor
reviewed
Apr 29, 2026
Co-authored-by: rebloor <git@sherpa.co.nz> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: rebloor <git@sherpa.co.nz>
Rob--W
commented
Apr 30, 2026
| Fires when one or more items in any of the {{WebExtAPIRef('storage.StorageArea', 'storage areas'}} changes. | ||
| If you only need to listen for changes in one storage area, use {{WebExtAPIRef('storage.StorageArea.onChanged')}} instead. | ||
|
|
||
| Fired when {{WebExtAPIRef('storage.StorageArea.set','storageArea.set')}}, {{WebExtAPIRef('storage.StorageArea.remove','storageArea.remove')}}, or {{WebExtAPIRef('storage.StorageArea.clear','storageArea.clear')}} executes against any of the {{WebExtAPIRef('storage.StorageArea', 'storage areas'}}. |
Member
Author
There was a problem hiding this comment.
@rebloor I did not see the edit you described in #43924 (review) . This is what you intended, right?
Suggested change
| Fired when {{WebExtAPIRef('storage.StorageArea.set','storageArea.set')}}, {{WebExtAPIRef('storage.StorageArea.remove','storageArea.remove')}}, or {{WebExtAPIRef('storage.StorageArea.clear','storageArea.clear')}} executes against any of the {{WebExtAPIRef('storage.StorageArea', 'storage areas'}}. |
Contributor
There was a problem hiding this comment.
As discussed elsewhere, the deleted line is b8ddbd3#diff-290285c0b842409595fc422eb75c72a432c324f46b53c9550c5b3f6cf18f7da6L13
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
storage/onchanged:
storage.managedbehavior that was already mentioned in the storage.StorageArea.onChanged docs.storage/storagearea:
StorageAreais an abstract type and explicitly mention the concrete APIs it applies to.storage/onchanged:
storage/setaccesslevel:
storage/storagechange:
Motivation
Documentation was inaccurate, misleading or confusing.
Additional details
Related issues and pull requests