StorageArea

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

Méthodes

clear()

browser.storage.StorageArea.clear(): Promise<void>

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

Renvoie

  • Promise<void>

    Chrome 95 et versions ultérieures browser.* depuis Chrome 148

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

get()

browser.storage.StorageArea.get(
  keys?: string | string[] | object,
): 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.

Renvoie

  • Promise<object>

    Chrome 95 et versions ultérieures browser.* depuis Chrome 148

    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.

getBytesInUse()

browser.storage.StorageArea.getBytesInUse(
  keys?: string | string[],
): 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.

Renvoie

  • Promise<number>

    Chrome 95 et versions ultérieures browser.* depuis Chrome 148

    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.

getKeys()

Chrome 130+ browser.* depuis Chrome 148 
browser.storage.StorageArea.getKeys(): Promise<string[]>

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

Renvoie

  • Promise<string[]>

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

remove()

browser.storage.StorageArea.remove(
  keys: string | string[],
): 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.

Renvoie

  • Promise<void>

    Chrome 95 et versions ultérieures browser.* depuis Chrome 148

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

set()

browser.storage.StorageArea.set(
  items: object,
): 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).

Renvoie

  • Promise<void>

    Chrome 95 et versions ultérieures browser.* depuis Chrome 148

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

setAccessLevel()

Navigateur Chrome 102 ou version ultérieure * depuis Chrome 148 
browser.storage.StorageArea.setAccessLevel(
  accessOptions: object,
): 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.

Renvoie

  • Promise<void>

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

Événements

onChanged

Chrome 73 et versions ultérieures browser.* depuis Chrome 148 
browser.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