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 autres Array et Object, 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 la permission « storage » dans votre fichier manifest.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 utiliser Window.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'API storage.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.

Types

storage.StorageArea

Un objet représentant la zone de stockage.

storage.StorageChange

Un 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.sync

Représente la zone de stockage sync. Les items dans sync sont synchronisés par le navigateur, et disponibles pour toutes les instances de ce navigateur auxquelles l'utilisateur est connecté, pour tous les appareils.

storage.local

Représente la zone de stockage local. Les items dans local sont limités à l'appareil sur lequel l'extension a été installée.

storage.managed

Représente la zone de stockage managed. Les items dans managed sont 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.onChanged

Activé quand un ou plusieurs items d'une zone de stockage sont modifiés.

Compatibilité des navigateurs

Report problems with this compatibility data on GitHub
desktopmobile
Chrome
Edge
Firefox
Opera
Safari
Firefox for Android
Safari on iOS
storage
StorageArea
StorageArea.clear
StorageArea.get
Supports empty key
StorageArea.getBytesInUse
StorageArea.onChanged
StorageArea.remove
Supports empty key
StorageArea.set
StorageArea.setAccessLevel
StorageChange
local
local.clear
local.get
Supports empty key
local.getBytesInUse
local.onChanged
local.remove
Supports empty key
local.set
managed
managed.clear
managed.get
managed.getBytesInUse
managed.onChanged
managed.remove
managed.set
onChanged
session
session.QUOTA_BYTES
session.clear
session.get
Supports empty key
session.getBytesInUse
session.onChanged
session.remove
Supports empty key
session.set
session.setAccessLevel
sync
sync.clear
sync.get
Supports empty key
sync.getBytesInUse
sync.onChanged
sync.remove
Supports empty key
sync.set

Legend

Tip: you can click/tap on a cell for more information.

Full support
Full support
Partial support
Partial support
No support
No support
See implementation notes.

Example extensions

Note :

Cette API est basée sur l'API Chromium chrome.storage. Cette documentation est dérivée de storage.json dans le code de Chromium.

Les données de compatibilité relatives à Microsoft Edge sont fournies par Microsoft Corporation et incluses ici sous la licence Creative Commons Attribution 3.0 pour les États-Unis.