StorageArea

La API de chrome.storage usa la interfaz StorageArea.

Métodos

clear()

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

Quita todos los elementos del almacenamiento.

Parámetros

  • callback

    función opcional

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

    () => void

Muestra

  • Promise<void>

    Chrome 95 y versiones posteriores

    Las promesas solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

get()

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

Obtiene uno o más elementos del almacenamiento.

Parámetros

  • claves

    cadena | cadena[] | objeto opcional

    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.

  • callback

    función opcional

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

    (items: object) => void

    • elementos

      objeto

      Objeto con elementos en sus asignaciones de clave-valor.

Muestra

  • Promise<object>

    Chrome 95 y versiones posteriores

    Las promesas solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

getBytesInUse()

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

  • callback

    función opcional

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

    (bytesInUse: number) => void

    • bytesInUse

      número

      Cantidad de espacio que se usa en el almacenamiento, en bytes.

Muestra

  • Promise<number>

    Chrome 95 y versiones posteriores

    Las promesas solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

getKeys()

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

Obtiene todas las claves del almacenamiento.

Parámetros

  • callback

    función opcional

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

    (keys: string[]) => void

    • claves

      string[]

      Es un array con las claves leídas del almacenamiento.

Muestra

  • Promise<string[]>

    Las promesas solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

remove()

Promise 
chrome.storage.StorageArea.remove(
  keys: string | string[],
  callback?: function,
): 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.

  • callback

    función opcional

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

    () => void

Muestra

  • Promise<void>

    Chrome 95 y versiones posteriores

    Las promesas solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

set()

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

Establece varios elementos.

Parámetros

  • elementos

    objeto

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

    Los valores primitivos, como los números, se serializarán según lo esperado. Por lo general, los valores con un typeof, un "object" y un "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).

  • callback

    función opcional

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

    () => void

Muestra

  • Promise<void>

    Chrome 95 y versiones posteriores

    Las promesas solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

setAccessLevel()

Promise Chrome 102 y versiones posteriores 
chrome.storage.StorageArea.setAccessLevel(
  accessOptions: object,
  callback?: function,
): 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.

  • callback

    función opcional

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

    () => void

Muestra

  • Promise<void>

    Las promesas solo se admiten en Manifest V3 y versiones posteriores. Otras plataformas deben usar devoluciones de llamada.

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