StorageArea

La API de browser.storage usa la interfaz StorageArea.

Métodos

clear()

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

Quita todos los elementos del almacenamiento.

Muestra

  • Promise<void>

    Chrome 95 y versiones posteriores browser.* desde Chrome 148

    Es una promesa que se resuelve si se completa correctamente o se rechaza si falla.

get()

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

Obtiene uno o más elementos del almacenamiento.

Parámetros

  • claves

    string | string[] | object opcional

    Una sola clave para obtener, una lista de claves para obtener o un diccionario que especifique los 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 browser.* desde Chrome 148

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

getBytesInUse()

browser.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

    string | string[] opcional

    Una sola clave o una lista de claves para obtener el uso total. Una lista vacía devolverá 0. Pasa null para obtener el uso total de todo el almacenamiento.

Muestra

  • Promise<number>

    Chrome 95 y versiones posteriores browser.* desde Chrome 148

    Es una promesa que se resuelve con la cantidad de espacio que usa el almacenamiento o se rechaza en caso de error.

getKeys()

Chrome 130 y versiones posteriores browser.* desde Chrome 148 
browser.storage.StorageArea.getKeys(): Promise<string[]>

Obtiene todas las claves del almacenamiento.

Muestra

  • Promise<string[]>

    Es una promesa que se resuelve con claves de almacenamiento o se rechaza en caso de error.

remove()

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

Quita uno o más elementos del almacenamiento.

Parámetros

  • claves

    string | string[]

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

Muestra

  • Promise<void>

    Chrome 95 y versiones posteriores browser.* desde Chrome 148

    Es una promesa que se resuelve si se completa correctamente o se rechaza si falla.

set()

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

Establece varios elementos.

Parámetros

  • elementos

    objeto

    Es un objeto que proporciona cada par clave-valor con el que se actualizará el almacenamiento. No se verán afectados los demás pares clave-valor en el almacenamiento.

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

Muestra

  • Promise<void>

    Chrome 95 y versiones posteriores browser.* desde Chrome 148

    Es una promesa que se resuelve si se completa correctamente o se rechaza si falla.

setAccessLevel()

Chrome 102 y versiones posteriores browser.* desde Chrome 148 
browser.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 extensiones 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>

    Es una promesa que se resuelve si se completa correctamente o se rechaza si falla.

Eventos

onChanged

Chrome 73 y versiones posteriores browser.* desde Chrome 148 
browser.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