我们的志愿者还没有将这篇文章翻译为 中文 (简体)。加入我们帮助完成翻译！
Enables WebExtensions 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.
To use this API you need to include the "storage" permission in your manifest.json file. Each WebExtension has its own storage area, which can be split into different types of storage.
Types
storage.StorageArea- An object representing a storage area.
storage.StorageChange- An object representing a change to a storage area.
Properties
storage has three properties, which represent the different types of available storage area.
storage.sync- Represents the
syncstorage area. Items insyncstorage are synced by the browser, and are available across all instances of that browser that the user is logged into, across different devices. storage.local- Represents the
localstorage area. Items inlocalstorage are local to the machine the extension was installed on. storage.managed- Represents the
managedstorage area. Items inmanagedstorage are set by the domain administrator and are read-only for the extension. Trying to modify this namespace results in an error.
Events
storage.onChanged- Fired when one or more items change in a storage area.
Browser compatibility
| Chrome | Edge | Firefox | Firefox for Android | Opera | |
|---|---|---|---|---|---|
StorageArea |
Yes | Yes | 45.0 | 48.0 | 33 |
StorageArea.clear |
Yes | Yes | 45.0 | 48.0 | 33 |
StorageArea.get |
Yes | Yes | 45.0 | 48.0 | 33 |
StorageArea.getBytesInUse |
Yes | Yes | 45.0 | 48.0 | 33 |
StorageArea.remove |
Yes | Yes | 45.0 | 48.0 | 33 |
StorageArea.set |
Yes | Yes * | 45.0 | 48.0 | 33 |
StorageChange |
Yes | Yes | 45.0 | 48.0 | 33 |
local |
Yes | Yes | 45.0 * | 48.0 | 33 |
managed |
Yes | No | No | No | No |
onChanged |
Yes | Yes | 45.0 | 48.0 | 33 |
sync |
Yes | No | No | No | No |
The "Chrome incompatibilities" section is included from https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Chrome_incompatibilities using the WebExtChromeCompat macro.
If you need to update this content, edit https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Chrome_incompatibilities, then shift-refresh this page to see your changes.
Chrome incompatibilities
- Firefox does not support:
managedstorage areasyncstorage areagetBytesInUse().
Example add-ons
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.
// 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.