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:
- It's asynchronous.
- Values are scoped to the extension, not to a specific domain (i.e. the same set of key/value pairs are available to all scripts in the background context and content scripts).
- The values stored can be any JSON-ifiable value, not just
String. Among other things, this includes:
Object, but only when their contents can can be represented as JSON, which does not include DOM nodes. You don't need to convert your values to JSON
Stringsprior to storing them, but they are represented as JSON internally, thus the requirement that they be JSON-ifiable.
- Multiple key/value pairs can be set or retrieved in the same API call.
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.
- An object representing a storage area.
- An object representing a change to a storage area.
storage has three properties, which represent the different types of available storage area.
- Represents the
syncstorage area. Items in
syncstorage are synced by the browser, and are available across all instances of that browser that the user is logged into, across different devices.
- Represents the
localstorage area. Items in
localstorage are local to the machine the extension was installed on.
- Represents the
managedstorage area. Items in
managedstorage are set by the domain administrator and are read-only for the extension. Trying to modify this namespace results in an error.
- Fired when one or more items change in a storage area.
|Chrome||Edge||Firefox||Firefox for Android||Opera|
|Yes||Yes *||45 *||48 *||Yes *|
Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.
// Copyright 2015 The Chromium Authors. All rights reserved. // // Redistribution and use in source and binary forms, with or without // modification, are permitted provided that the following conditions are // met: // // * Redistributions of source code must retain the above copyright // notice, this list of conditions and the following disclaimer. // * Redistributions in binary form must reproduce the above // copyright notice, this list of conditions and the following disclaimer // in the documentation and/or other materials provided with the // distribution. // * Neither the name of Google Inc. nor the names of its // contributors may be used to endorse or promote products derived from // this software without specific prior written permission. // // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.