storage.onChanged
Fired when storageArea.set, storageArea.remove, or storageArea.clear executes against a storage area, returning details of only changed keys. A callback is called only when there are changes to the underlying data.
Note:
In Firefox, the information returned includes all keys within the storage area storageArea.set ran against whether they changed or not. Also, a callback may be invoked when there is no change to the underlying data. Details of the changed items are found by examining each returned key's storage.StorageChange object. See Firefox bug 1833153.
Syntax
browser.storage.onChanged.addListener(listener)
browser.storage.onChanged.removeListener(listener)
browser.storage.onChanged.hasListener(listener)
Events have three functions:
addListener(listener)-
Adds a listener to this event.
removeListener(listener)-
Stop listening to this event. The
listenerargument is the listener to remove. hasListener(listener)-
Check whether
listeneris registered for this event. Returnstrueif it is listening,falseotherwise.
addListener syntax
Parameters
listener-
The function called when this event occurs. The function is passed these arguments:
changes-
object. Object describing the change. The name of each property is the name of each key. The value of each key is astorage.StorageChangeobject describing the change to that item. areaName-
string. The name of the storage area ("sync","local", or"managed") to which the changes were made.
Examples
/*
Log the storage area that changed,
then for each item changed,
log its old value and its new value.
*/
function logStorageChange(changes, area) {
console.log(`Change in storage area: ${area}`);
const changedItems = Object.keys(changes);
for (const item of changedItems) {
console.log(`${item} has changed:`);
console.log("Old value: ", changes[item].oldValue);
console.log("New value: ", changes[item].newValue);
}
}
browser.storage.onChanged.addListener(logStorageChange);
Example extensions
Browser compatibility
Loading…
Note:
This API is based on Chromium's chrome.storage API. This documentation is derived from storage.json in the Chromium code.