storage
מאפשר להרחבות לאחסן ולשלוף נתונים, ולהאזין לשינויים בפריטים המאוחסנים.
מערכת האחסון מבוססת על ממשק פיתוח היישומים Web Storage, עם מספר הבדלים. בין ההבדלים ניתן למצוא כי:
- היא אסינכרונית.
- הערכים הם בתוחם של ההרחבה, לא של מתחם כלשהו (כלומר. אותה קבוצה של זוגות מפתח/ערך זמינה לכל התסריטים בהקשר הרקע ובתסריטי התוכן).
- הערכים המאוחסנים יכולים להיות כל ערך הניתן לסריאליזציית , לא רק
String
. בין היתר, זה כולל:Array
ו-Object
, אך רק כשהתוכן שלהם יכול להיות מיוצג ב- JSON, שאינו כולל צמתי DOM. אין צורך בהסבת הערים למחרוזות JSON בטרם יאוחסנו, אך הם מיוצגים פנימית כערכי JSON, ולכן הדרישה כי יוכלו להיות מיוצגים בפורמט JSON. - ניתן לקבוע ערכם של זוגות מפתח/ערך מרובים יכולים או לשלוף אותם באותה קריאה לממשק פיתוח היישומים.
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
.
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
sync
storage area. Items insync
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.local
- Represents the
local
storage area. Items inlocal
storage are local to the machine the extension was installed on. storage.managed
- Represents the
managed
storage area. Items inmanaged
storage 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
BCD tables only load in the browser
Example extensions
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.