Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

storage.onChanged clarrification #18326

Merged
merged 3 commits into from Aug 10, 2022
Merged

storage.onChanged clarrification #18326

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8238068
storage.onChanged clarrification
rebloor Jul 13, 2022
b0f1987
Feedback update
rebloor Jul 14, 2022
2b34c34
Feedback update
rebloor Aug 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 5 additions & 3 deletions files/en-us/mozilla/add-ons/webextensions/api/storage/onchanged/index.md
View file
Open in desktop
Expand Up @@ -15,7 +15,9 @@ browser-compat: webextensions.api.storage.onChanged
---
{{AddonSidebar()}}

Fired when one or more items change.
Fired when {{WebExtAPIRef('storage.StorageArea.set','storageArea.set')}}, {{WebExtAPIRef('storage.StorageArea.remove','storageArea.remove')}}, or {{WebExtAPIRef('storage.StorageArea.clear','storageArea.clear')}} executes against a storage area.

When this event is triggered by {{WebExtAPIRef('storage.StorageArea.set','storageArea.set')}}, it's possible to receive a callback when there is no change to the underlying data. Also, the information returned includes all keys within the storage area {{WebExtAPIRef('storage.StorageArea.set','storageArea.set')}} ran against. The extension can determine the changes that occurred by examining the content of the `changes` argument received by the `onChanged` listeners.

## Syntax

Expand All @@ -40,10 +42,10 @@ Events have three functions:

- `callback`

- : Function that will be called when this event occurs. The function will be passed the following arguments:
- : The function called when this event occurs. The function is passed these arguments:

- `changes`
- : `object`. Object describing the change. This contains one property for each key that changed. The name of the property is the name of the key that changed, and its value is a {{WebExtAPIRef('storage.StorageChange')}} object describing the change to that item.
- : `object`. Object describing the change. This object contains properties for all the keys in the storage area included in the {{WebExtAPIRef('storage.StorageArea.set','storageAred.set')}} call, even if key values are unchanged. The name of each property is the name of each key. The value of each key is a {{WebExtAPIRef('storage.StorageChange')}} object describing the change to that item.
- `areaName`
- : `string`. The name of the storage area (`"sync"`, `"local"`, or `"managed"`) to which the changes were made.

Expand Down