chrome.storage

Descripción

Usa la API de chrome.storage para almacenar, recuperar y hacer un seguimiento de los cambios en los datos del usuario.

Permisos

storage

Descripción general

La API de Storage proporciona una forma específica de la extensión para conservar los datos y el estado del usuario. Es similar a las APIs de almacenamiento de la plataforma web (IndexedDB y Storage), pero se diseñó para satisfacer las necesidades de almacenamiento de las extensiones. Estas son algunas de sus funciones clave:

  • Todos los contextos de extensión, incluidos el trabajador de servicio de la extensión y las secuencias de comandos de contenido, tienen acceso a la API de Storage.
  • Los valores serializables en JSON se almacenan como propiedades de objetos.
  • La API de Storage es asíncrona y admite operaciones de lectura y escritura masivas.
  • Los datos persisten incluso si el usuario borra la caché y el historial de navegación.
  • Los parámetros de configuración almacenados persisten incluso cuando se usa el modo Incógnito dividido.
  • Incluye un área de almacenamiento administrada exclusiva de solo lectura para las políticas empresariales.

Aunque las extensiones pueden usar la interfaz [Storage][mdn-storage] (accesible desde window.localStorage) en algunos contextos (páginas emergentes y otras páginas HTML), no se recomienda por los siguientes motivos:

  • El service worker de la extensión no puede acceder a Storage.
  • Las secuencias de comandos de contenido comparten almacenamiento con la página host.
  • Los datos guardados con la interfaz Storage se pierden cuando el usuario borra su historial de navegación.

Para mover datos de las APIs de almacenamiento web a las APIs de almacenamiento de extensiones desde un service worker, haz lo siguiente:

  1. Crea un documento fuera de pantalla con una rutina de conversión y un controlador [onMessage][on-message].
  2. Agrega una rutina de conversión a un documento fuera de pantalla.
  3. En la verificación del service worker de la extensión, busca chrome.storage para tus datos.
  4. Si no se encuentran tus datos, [crea][create-offscreen] un documento fuera de la pantalla y llama a [sendMessage()][send-message] para iniciar la rutina de conversión.
  5. Dentro del controlador onMessage del documento fuera de pantalla, llama a la rutina de conversión.

También hay algunos matices sobre cómo funcionan las APIs de almacenamiento web en las extensiones. Obtén más información en el artículo [Almacenamiento y cookies][storage-and-cookies].

Áreas de almacenamiento

La API de Storage se divide en los siguientes cuatro buckets ("áreas de almacenamiento"):

storage.local
Los datos se almacenan de forma local y se borran cuando se quita la extensión. La limitación de cuota es de aproximadamente 10 MB, pero se puede aumentar solicitando el permiso "unlimitedStorage". Considera usarlo para almacenar grandes cantidades de datos.
storage.sync
Si la sincronización está habilitada, los datos se sincronizan con cualquier navegador Chrome en el que el usuario haya accedido. Si está inhabilitado, se comporta como storage.local. Chrome almacena los datos de forma local cuando el navegador está sin conexión y reanuda la sincronización cuando vuelve a estar en línea. La limitación de la cuota es de aproximadamente 100 KB, es decir, 8 KB por elemento. Considera usarlo para conservar la configuración del usuario en los navegadores sincronizados.
storage.session
Mantiene los datos en la memoria durante la sesión del navegador. De forma predeterminada, no se expone a las secuencias de comandos de contenido, pero este comportamiento se puede cambiar configurando chrome.storage.session.setAccessLevel(). La limitación de la cuota es de aproximadamente 10 MB. Considera usarlo para almacenar variables globales en las ejecuciones del service worker.
storage.managed
Los administradores pueden usar un esquema y políticas empresariales para configurar los parámetros de configuración de una extensión compatible en un entorno administrado. Esta área de almacenamiento es de solo lectura.

Manifiesto

Para usar la API de Storage, declara el permiso "storage" en el manifiesto de la extensión. Por ejemplo:

{
  "name": "My extension",
  ...
  "permissions": [
    "storage"
  ],
  ...
}

Uso

En los siguientes ejemplos, se muestran las áreas de almacenamiento local, sync y session:

storage.local

chrome.storage.local.set({ key: value }).then(() => {
  console.log("Value is set");
});

chrome.storage.local.get(["key"]).then((result) => {
  console.log("Value currently is " + result.key);
});

storage.sync

chrome.storage.sync.set({ key: value }).then(() => {
  console.log("Value is set");
});

chrome.storage.sync.get(["key"]).then((result) => {
  console.log("Value currently is " + result.key);
});

storage.session

chrome.storage.session.set({ key: value }).then(() => {
  console.log("Value was set");
});

chrome.storage.session.get(["key"]).then((result) => {
  console.log("Value currently is " + result.key);
});

Para obtener más información sobre el área de almacenamiento managed, consulta Manifiesto para áreas de almacenamiento.

Límites de almacenamiento y regulación

No pienses que agregar elementos a la API de Storage es como poner cosas en un camión grande. Piensa en agregar datos al almacenamiento como si pusieras algo en una tubería. Es posible que la tubería ya tenga material en su interior y que incluso esté llena. Siempre supón que hay una demora entre el momento en que agregas contenido al almacenamiento y el momento en que se registra.

Para obtener detalles sobre las limitaciones del área de almacenamiento y lo que sucede cuando se superan, consulta la información de cuotas de sync, local y session.

Casos de uso

En las siguientes secciones, se muestran casos de uso comunes de la API de Storage.

Respuesta síncrona a las actualizaciones de almacenamiento

Para hacer un seguimiento de los cambios realizados en el almacenamiento, puedes agregar un objeto de escucha a su evento onChanged. Cuando cambia algo en el almacenamiento, se activa ese evento. El código de muestra detecta estos cambios:

background.js:

chrome.storage.onChanged.addListener((changes, namespace) => {
  for (let [key, { oldValue, newValue }] of Object.entries(changes)) {
    console.log(
      `Storage key "${key}" in namespace "${namespace}" changed.`,
      `Old value was "${oldValue}", new value is "${newValue}".`
    );
  }
});

Podemos llevar esta idea aún más lejos. En este ejemplo, tenemos una página de opciones que permite al usuario activar o desactivar un "modo de depuración" (la implementación no se muestra aquí). La página de opciones guarda inmediatamente la nueva configuración en storage.sync, y el trabajador de servicio usa storage.onChanged para aplicar el parámetro de configuración lo antes posible.

options.html:

<!-- type="module" allows you to use top level await -->
<script defer src="options.js" type="module"></script>
<form id="optionsForm">
  <label for="debug">
    <input type="checkbox" name="debug" id="debug">
    Enable debug mode
  </label>
</form>

options.js:

// In-page cache of the user's options
const options = {};
const optionsForm = document.getElementById("optionsForm");

// Immediately persist options changes
optionsForm.debug.addEventListener("change", (event) => {
  options.debug = event.target.checked;
  chrome.storage.sync.set({ options });
});

// Initialize the form with the user's option settings
const data = await chrome.storage.sync.get("options");
Object.assign(options, data.options);
optionsForm.debug.checked = Boolean(options.debug);

background.js:

function setDebugMode() { /* ... */ }

// Watch for changes to the user's options & apply them
chrome.storage.onChanged.addListener((changes, area) => {
  if (area === 'sync' && changes.options?.newValue) {
    const debugMode = Boolean(changes.options.newValue.debug);
    console.log('enable debug mode?', debugMode);
    setDebugMode(debugMode);
  }
});

Precarga asíncrona desde el almacenamiento

Dado que los service workers no siempre se ejecutan, las extensiones de Manifest V3 a veces necesitan cargar datos de forma asíncrona desde el almacenamiento antes de ejecutar sus controladores de eventos. Para ello, el siguiente fragmento usa un controlador de eventos action.onClicked asíncrono que espera a que se complete el objeto global storageCache antes de ejecutar su lógica.

background.js:

// Where we will expose all the data we retrieve from storage.sync.
const storageCache = { count: 0 };
// Asynchronously retrieve data from storage.sync, then cache it.
const initStorageCache = chrome.storage.sync.get().then((items) => {
  // Copy the data retrieved from storage into storageCache.
  Object.assign(storageCache, items);
});

chrome.action.onClicked.addListener(async (tab) => {
  try {
    await initStorageCache;
  } catch (e) {
    // Handle error that occurred during storage initialization.
  }

  // Normal action handler logic.
  storageCache.count++;
  storageCache.lastTabId = tab.id;
  chrome.storage.sync.set(storageCache);
});

Ejemplos de extensiones

Para ver otras demostraciones de la API de Storage, explora cualquiera de los siguientes ejemplos:

Tipos

AccessLevel

Chrome 102 y versiones posteriores

Es el nivel de acceso del área de almacenamiento.

Enum

"TRUSTED_CONTEXTS"
Especifica contextos que se originan en la propia extensión.

"TRUSTED_AND_UNTRUSTED_CONTEXTS"
Especifica contextos que se originan fuera de la extensión.

StorageArea

Propiedades

  • onChanged

    Event<functionvoidvoid>

    Chrome 73 y versiones posteriores

    Se activa cuando cambian uno o más elementos.

    La función onChanged.addListener se ve de la siguiente manera: 

    (callback: function) => {...}

    • callback

      función

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

      (changes: object) => void

      • Cambios

        objeto

  • borrar

    void

    Promesa

    Quita todos los elementos del almacenamiento.

    La función clear se ve de la siguiente manera: 

    (callback?: function) => {...}

    • 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

    void

    Promesa

    Obtiene uno o más elementos del almacenamiento.

    La función get se ve de la siguiente manera: 

    (keys?: string | string[] | object, callback?: function) => {...}

    • 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

    void

    Promesa

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

    La función getBytesInUse se ve de la siguiente manera: 

    (keys?: string | string[], callback?: function) => {...}

    • 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

    void

    Promesa Chrome 130 y versiones posteriores

    Obtiene todas las claves del almacenamiento.

    La función getKeys se ve de la siguiente manera: 

    (callback?: function) => {...}

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

  • quitar

    void

    Promesa

    Quita uno o más elementos del almacenamiento.

    La función remove se ve de la siguiente manera: 

    (keys: string | string[], callback?: function) => {...}

    • 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

    void

    Promesa

    Establece varios elementos.

    La función set se ve de la siguiente manera: 

    (items: object, callback?: function) => {...}

    • elementos

      objeto

      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

    void

    Promise Chrome 102 y versiones posteriores

    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 local y sync permite el acceso desde contextos de confianza y no confiables.

    La función setAccessLevel se ve de la siguiente manera: 

    (accessOptions: object, callback?: function) => {...}

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

StorageChange

Propiedades

  • newValue

    cualquier opción

    Es el valor nuevo del elemento, si hay un valor nuevo.

  • oldValue

    cualquier opción

    Es el valor anterior del elemento, si había uno.

Propiedades

local

Los elementos del área de almacenamiento local son locales para cada máquina.

Tipo

StorageArea y objeto

Propiedades

  • QUOTA_BYTES

    10485760

    Cantidad máxima (en bytes) de datos que se pueden almacenar en el almacenamiento local, según la conversión a cadena JSON de cada valor más la longitud de cada clave. Este valor se ignorará si la extensión tiene el permiso unlimitedStorage. Las actualizaciones que harían que se exceda este límite fallan de inmediato y establecen runtime.lastError cuando se usa una devolución de llamada, o una promesa rechazada si se usa async/await.

managed

Los elementos del área de almacenamiento managed se establecen mediante una política empresarial configurada por el administrador del dominio y son de solo lectura para la extensión. Si se intenta modificar este espacio de nombres, se produce un error. Para obtener información sobre cómo configurar una política, consulta Manifiesto para áreas de almacenamiento.

Tipo

StorageArea

sync

Los elementos del área de almacenamiento sync se sincronizan con la Sincronización de Chrome.

Tipo

StorageArea y objeto

Propiedades

  • MAX_ITEMS

    512

    Es la cantidad máxima de elementos que se pueden almacenar en el almacenamiento de sincronización. Las actualizaciones que harían que se exceda este límite fallarán de inmediato y establecerán runtime.lastError cuando se use una devolución de llamada o cuando se rechace una promesa.

  • MAX_SUSTAINED_WRITE_OPERATIONS_PER_MINUTE

    1000000

    Obsoleto

    La API de storage.sync ya no tiene una cuota de operaciones de escritura sostenidas.

  • MAX_WRITE_OPERATIONS_PER_HOUR

    1800

    Es la cantidad máxima de operaciones de set, remove o clear que se pueden realizar por hora. Esto equivale a 1 cada 2 segundos, un límite inferior al límite a corto plazo de mayor cantidad de escrituras por minuto.

    Las actualizaciones que harían que se exceda este límite fallan de inmediato y establecen runtime.lastError cuando se usa una devolución de llamada o cuando se rechaza una promesa.

  • MAX_WRITE_OPERATIONS_PER_MINUTE

    120

    Es la cantidad máxima de operaciones de set, remove o clear que se pueden realizar por minuto. Esto equivale a 2 por segundo, lo que proporciona una mayor capacidad de procesamiento que las escrituras por hora durante un período más corto.

    Las actualizaciones que harían que se exceda este límite fallan de inmediato y establecen runtime.lastError cuando se usa una devolución de llamada o cuando se rechaza una promesa.

  • QUOTA_BYTES

    102400

    Es la cantidad total máxima (en bytes) de datos que se pueden almacenar en el almacenamiento de sincronización, según la conversión a cadena JSON de cada valor más la longitud de cada clave. Las actualizaciones que harían que se exceda este límite fallan de inmediato y establecen runtime.lastError cuando se usa una devolución de llamada o cuando se rechaza una promesa.

  • QUOTA_BYTES_PER_ITEM

    8192

    Es el tamaño máximo (en bytes) de cada elemento individual en el almacenamiento de sincronización, medido por la conversión a cadena JSON de su valor más la longitud de su clave. Las actualizaciones que contengan elementos más grandes que este límite fallarán de inmediato y establecerán runtime.lastError cuando se use una devolución de llamada o cuando se rechace una promesa.

Eventos

onChanged

chrome.storage.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, areaName: string) => void

    • Cambios

      objeto

    • areaName

      string