Cette page a été traduite à partir de l'anglais par la communauté.Vous pouvez contribuer en rejoignant la communauté francophone sur MDN Web Docs.
storage
Permet aux extensions de stocker et de récupérer des données et d'écouter les modifications apportées aux éléments stockés.
Le mécanisme de stockage est basé sur l'API Web Storage, à quelques différences près. Elles incluent entre autres :
- Le mécanisme est asynchrone.
- La portée des valeurs s'étend à l'extension, pas à un domaine en particulier (c-à-d que les mêmes paires clef/valeur sont disponibles pour tous les scripts d'arrière-plan et de contenu).
- Les valeurs stockées peuvent être de tout type compatible avec JSON et pas uniquement
String. Ce qui inclut entre autresArrayetObject, mais seulement si leur contenu peut être représenté en JSON, ce qui exclut les nœuds DOM. Il n'est pas nécessaire de convertir vos valeurs en JSON Strings avant de les stocker, mais elles sont représentées en JSON en interne, d'où l'impératif de compatibilité. - Plusieurs paires clef/valeur peuvent être récupérées par un même appel à l'API.
Pour utiliser cette API vous devez inclure lapermission « storage » dans votre fichiermanifest.json.
Chaque extension a sa propre zone de stockage, qui peut être divisée entre plusieurs types de stockage.
Bien que cette API soit semblable àWindow.localStorage il est conseillé de ne pas utiliserWindow.localStorage dans le code de l'extension pour stocker ses données. Firefox effacera les données stockées via l'API localStorage par les extensions dans plusieurs scénarios où les utilisateurs effacent leur historique de navigation ou des données pour des raisons de confidentialité, alors que les données sauvées en utilisant l'APIstorage.local seront correctement conservées dans ces scénarios.
Note :La zone de stockage n'est pas chiffrée et ne doit pas être utilisée pour stocker des informations confidentielles sur les utilisateurs.
Dans cet article
Types
storage.StorageAreaUn objet représentant la zone de stockage.
storage.StorageChangeUn objet représentant une modification d'une zone de stockage.
Propriétés
storage a trois propriétés, qui représentent les différents types de zones de stockage disponibles.
storage.syncReprésente la zone de stockage
sync. Les items danssyncsont synchronisés par le navigateur, et disponibles pour toutes les instances de ce navigateur auxquelles l'utilisateur est connecté, pour tous les appareils.storage.localReprésente la zone de stockage
local. Les items danslocalsont limités à l'appareil sur lequel l'extension a été installée.storage.managedReprésente la zone de stockage
managed. Les items dansmanagedsont en écriture pour l'administrateur du domaine et en lecture seule pour l'extension. Tenter de modifier cet espace de nom renvoie une erreur.
Événements
storage.onChangedActivé quand un ou plusieurs items d'une zone de stockage sont modifiés.
Compatibilité des navigateurs
Exemples d'extensions
- annotate-page
- favourite-colour
- forget-it
- navigation-stats
- proxy-blocker
- quicknote
- stored-credentials
- userScripts-mv3
Note :
Cette API est basée sur l'API Chromiumchrome.storage. Cette documentation est dérivée destorage.json dans le code de Chromium.