StorageArea

refresh date: 2026-09-25 robots: noindex

L'interface StorageArea est utilisée par l'API chrome.storage.

Méthodes

clear()

Promise 
chrome.storage.StorageArea.clear(
  callback?: function,
): Promise<void>

Supprime tous les éléments de l'espace de stockage.

Paramètres

  • callback

    function facultatif

    Le paramètre callback se présente comme suit : 

    () => void

Renvoie

  • Promise<void>

    Chrome 95 ou version ultérieure

    Promesse qui se résout en cas de réussite ou qui est rejetée en cas d'échec.

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

get()

Promise 
chrome.storage.StorageArea.get(
  keys?: string | string[] | object,
  callback?: function,
): Promise<object>

Récupère un ou plusieurs éléments du stockage.

Paramètres

  • clés

    string | string[] | object facultatif

    Une seule clé à obtenir, une liste de clés à obtenir ou un dictionnaire spécifiant les valeurs par défaut (voir la description de l'objet). Une liste ou un objet vide renverra un objet de résultat vide. Transmettez null pour obtenir l'intégralité du contenu de l'espace de stockage.

  • callback

    function facultatif

    Le paramètre callback se présente comme suit : 

    (items: object) => void

    • éléments

      objet

      Objet avec des éléments dans leurs mappages clé-valeur.

Renvoie

  • Promise<object>

    Chrome 95 ou version ultérieure

    Promesse qui se résout avec un objet contenant un mappage clé-valeur pour les éléments demandés, ou qui est rejetée en cas d'échec.

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

getBytesInUse()

Promise 
chrome.storage.StorageArea.getBytesInUse(
  keys?: string | string[],
  callback?: function,
): Promise<number>

Récupère la quantité d'espace (en octets) utilisée par un ou plusieurs éléments.

Paramètres

  • clés

    string | string[] facultatif

    Une seule clé ou une liste de clés pour lesquelles obtenir l'utilisation totale. Une liste vide renvoie 0. Transmettez null pour obtenir l'utilisation totale de l'ensemble de l'espace de stockage.

  • callback

    function facultatif

    Le paramètre callback se présente comme suit : 

    (bytesInUse: number) => void

    • bytesInUse

      nombre

      Espace utilisé dans l'espace de stockage, en octets.

Renvoie

  • Promise<number>

    Chrome 95 ou version ultérieure

    Promesse qui se résout avec la quantité d'espace utilisée par l'espace de stockage ou qui est rejetée en cas d'échec.

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

getKeys()

Promise Chrome 130+ 
chrome.storage.StorageArea.getKeys(
  callback?: function,
): Promise<string[]>

Récupère toutes les clés du stockage.

Paramètres

  • callback

    function facultatif

    Le paramètre callback se présente comme suit : 

    (keys: string[]) => void

    • clés

      chaîne[]

      Tableau contenant les clés lues à partir de l'espace de stockage.

Renvoie

  • Promise<string[]>

    Promesse qui se résout avec les clés de stockage ou qui est rejetée en cas d'échec.

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

remove()

Promise 
chrome.storage.StorageArea.remove(
  keys: string | string[],
  callback?: function,
): Promise<void>

Supprime un ou plusieurs éléments de l'espace de stockage.

Paramètres

  • clés

    string | string[]

    Une seule clé ou une liste de clés pour les éléments à supprimer.

  • callback

    function facultatif

    Le paramètre callback se présente comme suit : 

    () => void

Renvoie

  • Promise<void>

    Chrome 95 ou version ultérieure

    Promesse qui se résout en cas de réussite ou qui est rejetée en cas d'échec.

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

set()

Promise 
chrome.storage.StorageArea.set(
  items: object,
  callback?: function,
): Promise<void>

Définit plusieurs éléments.

Paramètres

  • éléments

    objet

    Objet qui fournit chaque paire clé/valeur avec laquelle mettre à jour l'espace de stockage. Les autres paires clé/valeur de l'espace de stockage ne seront pas affectées.

    Les valeurs primitives telles que les nombres seront sérialisées comme prévu. Les valeurs avec un typeof "object" et "function" sont généralement sérialisées en {}, à l'exception de Array (sérialisé comme prévu), Date et Regex (sérialisés à l'aide de leur représentation String).

  • callback

    function facultatif

    Le paramètre callback se présente comme suit : 

    () => void

Renvoie

  • Promise<void>

    Chrome 95 ou version ultérieure

    Promesse qui se résout en cas de réussite ou qui est rejetée en cas d'échec.

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

setAccessLevel()

Promise Chrome 102+ 
chrome.storage.StorageArea.setAccessLevel(
  accessOptions: object,
  callback?: function,
): Promise<void>

Définit le niveau d'accès souhaité pour la zone de stockage. Par défaut, l'espace de stockage session est limité aux contextes de confiance (pages d'extension et service workers), tandis que les espaces de stockage managed, local et sync autorisent l'accès à partir de contextes de confiance et non approuvés.

Paramètres

  • accessOptions

    objet

    • accessLevel

      AccessLevel

      Niveau d'accès de la zone de stockage.

  • callback

    function facultatif

    Le paramètre callback se présente comme suit : 

    () => void

Renvoie

  • Promise<void>

    Promesse qui se résout en cas de réussite ou qui est rejetée en cas d'échec.

    Les promesses ne sont compatibles qu'avec Manifest V3 et les versions ultérieures. Les autres plates-formes doivent utiliser des rappels.

Événements

onChanged

Chrome 73 ou version ultérieure 
chrome.storage.StorageArea.onChanged.addListener(
  callback: function,
)

Se déclenche lorsqu'un ou plusieurs éléments sont modifiés.

Paramètres

  • callback

    fonction

    Le paramètre callback se présente comme suit : 

    (changes: object) => void

    • modifications

      objet