StorageArea

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 du stockage.

Paramètres

  • callback

    function facultatif

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

    () => void

Renvoie

  • Promise<void>

    Chrome 95 et versions ultérieures

    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

    Clé unique à obtenir, liste de clés à obtenir ou dictionnaire spécifiant les valeurs par défaut (voir la description de l'objet). Une liste ou un objet vides renverront un objet de résultat vide. Transmettez null pour obtenir l'intégralité du contenu du 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 et versions ultérieures

    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>

Obtient la quantité d'espace (en octets) utilisée par un ou plusieurs éléments.

Paramètres

  • clés

    string | string[] facultatif

    Clé unique ou liste de clés pour lesquelles obtenir l'utilisation totale. Une liste vide renvoie la valeur 0. Transmettez null pour obtenir l'utilisation totale de l'espace de stockage.

  • callback

    function facultatif

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

    (bytesInUse: number) => void

    • bytesInUse

      nombre

      Quantité d'espace de stockage utilisé, en octets.

Renvoie

  • Promise<number>

    Chrome 95 et versions ultérieures

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

getKeys()

Promesse Chrome 130 et versions ultérieures 
chrome.storage.StorageArea.getKeys(
  callback?: function,
): Promise<string[]>

Obtient 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 du stockage.

Renvoie

  • Promise<string[]>

    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 du stockage.

Paramètres

  • clés

    chaîne | chaîne[]

    Clé unique ou liste de clés des éléments à supprimer.

  • callback

    function facultatif

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

    () => void

Renvoie

  • Promise<void>

    Chrome 95 et versions ultérieures

    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 pour mettre à jour le stockage. Les autres paires clé/valeur dans le stockage ne seront pas affectées.

    Les valeurs primitives telles que les nombres seront sérialisées comme prévu. Les valeurs avec 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 et versions ultérieures

    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 et versions ultérieures 
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, le stockage session est limité aux contextes approuvés (pages d'extension et service workers), tandis que le stockage managed, local et sync autorise l'accès à partir de contextes approuvés et non approuvés.

Paramètres

  • accessOptions

    objet

    • accessLevel

      AccessLevel

      Niveau d'accès à l'espace de stockage.

  • callback

    function facultatif

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

    () => void

Renvoie

  • Promise<void>

    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 et versions ultérieures 
chrome.storage.StorageArea.onChanged.addListener(
  callback: function,
)

Déclenché lorsqu'un ou plusieurs éléments changent.

Paramètres

  • callback

    fonction

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

    (changes: object) => void

    • modifications

      objet