storage.onChanged

Fired when storageArea.set, storageArea.remove, or storageArea.clear executes against a storage area.

When this event is triggered by 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 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

js

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 listener argument is the listener to remove.

hasListener(listener)

Check whether listener is registered for this event. Returns true if it is listening, false otherwise.

addListener syntax

Parameters

listener

The function called when this event occurs. The function is passed these arguments:

changes

object. Object describing the change. This object contains properties for all the keys in the storage area included in the storageArea.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 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.

Browser compatibility

BCD tables only load in the browser

Examples

js

/*
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

Note: This API is based on Chromium's chrome.storage API. This documentation is derived from storage.json in the Chromium code.