StorageArea

La API de browser.storage usa la interfaz StorageArea.

Métodos

clear()

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

Quita todos los elementos del almacenamiento.

Muestra

  • Promise<void>

    Chrome 95 y versiones posteriores

    Promesa que se resuelve si la operación se realiza correctamente o se rechaza si falla.

get()

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

Obtiene uno o más elementos del almacenamiento.

Parámetros

  • claves

    cadena | cadenas[] | objeto opcional

    Es una sola clave para obtener, una lista de claves para obtener o un diccionario que especifica valores predeterminados (consulta la descripción del objeto). Una lista o un objeto vacíos devolverán un objeto de resultado vacío. Pasa null para obtener todo el contenido del almacenamiento.

Muestra

  • Promise<object>

    Chrome 95 y versiones posteriores

    Es una promesa que se resuelve con un objeto que contiene un mapa de pares clave-valor para los elementos solicitados o se rechaza si falla.

getBytesInUse()

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

Obtiene la cantidad de espacio (en bytes) que usan uno o más elementos.

Parámetros

  • claves

    cadena | cadena[] opcional

    Es una sola clave o una lista de claves para las que se obtendrá el uso total. Si la lista está vacía, se devolverá 0. Pasa null para obtener el uso total de todo el almacenamiento.

Muestra

  • Promise<number>

    Chrome 95 y versiones posteriores

    Es una promesa que se resuelve con la cantidad de espacio que usa el almacenamiento o se rechaza si falla.

getKeys()

Chrome 130 y versiones posteriores 
chrome.storage.StorageArea.getKeys(): Promise<string[]>

Obtiene todas las claves del almacenamiento.

Muestra

  • Promise<string[]>

    Es una promesa que se resuelve con las claves de almacenamiento o se rechaza si falla.

remove()

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

Quita uno o más elementos del almacenamiento.

Parámetros

  • claves

    cadena | cadena[]

    Es una sola clave o una lista de claves de los elementos que se quitarán.

Muestra

  • Promise<void>

    Chrome 95 y versiones posteriores

    Promesa que se resuelve si la operación se realiza correctamente o se rechaza si falla.

set()

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

Establece varios elementos.

Parámetros

  • elementos

    objeto

    Objeto que proporciona cada par clave/valor para actualizar el almacenamiento. No se verán afectados otros pares clave-valor en el almacenamiento.

    Los valores primitivos, como los números, se serializarán según lo esperado. Por lo general, los valores con un typeof, "object" y "function" se serializarán en {}, con la excepción de Array (se serializa según lo esperado), Date y Regex (se serializan con su representación de String).

Muestra

  • Promise<void>

    Chrome 95 y versiones posteriores

    Promesa que se resuelve si la operación se realiza correctamente o se rechaza si falla.

setAccessLevel()

Chrome 102 y versiones posteriores 
chrome.storage.StorageArea.setAccessLevel(
  accessOptions: object,
): Promise<void>

Establece el nivel de acceso deseado para el área de almacenamiento. De forma predeterminada, el almacenamiento de session está restringido a contextos de confianza (páginas de extensión y service workers), mientras que el almacenamiento de managed, local y sync permite el acceso desde contextos de confianza y no confiables.

Parámetros

  • accessOptions

    objeto

    • accessLevel

      AccessLevel

      Es el nivel de acceso del área de almacenamiento.

Muestra

  • Promise<void>

    Promesa que se resuelve si la operación se realiza correctamente o se rechaza si falla.

Eventos

onChanged

Chrome 73 y versiones posteriores 
chrome.storage.StorageArea.onChanged.addListener(
  callback: function,
)

Se activa cuando cambian uno o más elementos.

Parámetros

  • callback

    función

    El parámetro callback se ve de la siguiente manera: 

    (changes: object) => void

    • Cambios

      objeto