MDN wants to learn about developers like you: https://qsurvey.mozilla.com/s3/MDN-dev-survey

Represents the sync storage area. Items in sync storage are synced by the browser, and are available across all instances of that browser that the user is logged into (e.g. via Firefox sync, or a Google account), across different devices.

Note that the implementation of sync.storage in Firefox relies on the Add-on ID. If you use sync.storage, you must set an ID for your extension using the applications manifest.json key.

The main use case of this API is to store preferences about your extension and allow the user to sync them to different profiles. You can store up to 100KB of data using this API. If you try to store more than this, the call will fail with an error message. The API is provided without any guarantees about uptime or performance.

Methods

The sync object implements the methods defined on the storage.StorageArea type:

storage.StorageArea.get()
Retrieves one or more items from the storage area.
storage.StorageArea.getBytesInUse()
Gets the amount of storage space (in bytes) used one or more items being stored in the storage area.
storage.StorageArea.set()
Stores one or more items in the storage area. If the item already exists, its value will be updated.
storage.StorageArea.remove()
Removes one or more items from the storage area.
storage.StorageArea.clear()
Removes all items from the storage area.

Browser compatibility

ChromeEdgeFirefoxFirefox for AndroidOpera
Basic supportYes1553NoNo

Example extensions

Acknowledgements

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

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

Document Tags and Contributors

 Contributors to this page: andrewtruongmoz, wbamberg, chrisdavidmills
 Last updated by: andrewtruongmoz,