Enables extensions to store and retrieve data, and listen for changes to stored items.
The storage system is based on the Web Storage API, with a few differences. Among other differences, these include:
String
. Among other things, this includes: Array
and Object
, but only when their contents can be represented as JSON, which does not include DOM nodes. You don't need to convert your values to JSON Strings
prior to storing them, but they are represented as JSON internally, thus the requirement that they be JSON-ifiable.To use this API you need to include the "storage"
permission in your manifest.json
file.
Each extension has its own storage area, which can be split into different types of storage.
Although this API is similar to Window.localStorage
it is recommended that you don't use Window.localStorage
in the extension code to store extension-related data. Firefox will clear data stored by extensions using the localStorage API in various scenarios where users clear their browsing history and data for privacy reasons, while data saved using the storage.local
API will be correctly persisted in these scenarios.
You can examine the stored data under the Extension Storage item in the Storage Inspector tab of the developer toolbox, accessible from about:debugging
.
Note: The storage area is not encrypted and shouldn't be used for storing confidential user information.
Typesstorage.StorageArea
An object representing a storage area.
storage.StorageChange
An object representing a change to a storage area.
storage
has four properties, which represent the different types of available storage area.
storage.local
Represents the local
storage area. Items in local
storage are local to the machine the extension was installed on.
storage.managed
Represents the managed
storage area. Items in managed
storage are set by the domain administrator and are read-only for the extension. Trying to modify this namespace results in an error.
storage.session
Represents the session
storage area. Items in session
storage are stored in memory and are not persisted to disk.
storage.sync
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, across different devices.
storage.onChanged
Fired when one or more items change in any of the storage areas.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.3