chrome.storage

Descrição

Use a API chrome.storage para armazenar, recuperar e acompanhar as mudanças nos dados do usuário.

Permissões

storage

Visão geral

A API Storage oferece uma maneira específica da extensão para manter os dados e o estado do usuário. Ela é semelhante às APIs de armazenamento da plataforma da Web (IndexedDB e Storage), mas foi projetada para atender às necessidades de armazenamento das extensões. Estes são alguns dos principais recursos:

  • Todos os contextos de extensão, incluindo o service worker de extensão e scripts de conteúdo, têm acesso à API Storage.
  • Os valores serializáveis JSON são armazenados como propriedades de objeto.
  • A API Storage é assíncrona com operações de leitura e gravação em massa.
  • Mesmo que o usuário limpe o cache e o histórico de navegação, os dados vão permanecer.
  • As configurações armazenadas são mantidas mesmo ao usar a navegação anônima dividida.
  • Inclui uma área de armazenamento gerenciado exclusiva somente leitura para políticas corporativas.

Embora as extensões possam usar a interface [Storage][mdn-storage] (acessível em window.localStorage) em alguns contextos (pop-up e outras páginas HTML), não é recomendável por estes motivos:

  • O service worker da extensão não pode acessar Storage.
  • Os scripts de conteúdo compartilham armazenamento com a página do host.
  • Os dados salvos usando a interface Storage são perdidos quando o usuário limpa o histórico de navegação.

Para mover dados de APIs de armazenamento da Web para APIs de armazenamento de extensão de um service worker:

  1. Crie um documento fora da tela com uma rotina de conversão e um gerenciador [onMessage][on-message].
  2. Adicione uma rotina de conversão a um documento fora da tela.
  3. No service worker de extensão, verifique seus dados em chrome.storage.
  4. Se os dados não forem encontrados, [crie][create-offscreen] um documento fora da tela e chame [sendMessage()][send-message] para iniciar a rotina de conversão.
  5. Chame a rotina de conversão no manipulador onMessage do documento fora da tela.

Também há algumas nuances sobre como as APIs de armazenamento da Web funcionam em extensões. Saiba mais no artigo [Armazenamento e cookies][storage-and-cookies].

Áreas de armazenamento

A API Storage é dividida nestes quatro buckets ("áreas de armazenamento"):

storage.local
Os dados são armazenados localmente e são limpos quando a extensão é removida. A limitação de cota é de aproximadamente 10 MB, mas pode ser aumentada solicitando a permissão "unlimitedStorage". Considere usá-lo para armazenar quantidades maiores de dados.
storage.sync
Se a sincronização estiver ativada, os dados serão sincronizados com qualquer navegador Chrome em que o usuário tenha feito login. Se desativado, ele se comporta como storage.local. O Chrome armazena os dados localmente quando o navegador está off-line e retoma a sincronização quando fica on-line novamente. A limitação de cota é de aproximadamente 100 KB, 8 KB por item. Considere usá-la para preservar as configurações de usuário em navegadores sincronizados.
storage.session
Armazena dados na memória durante a sessão do navegador. Por padrão, ele não é exposto a scripts de conteúdo, mas esse comportamento pode ser alterado configurando chrome.storage.session.setAccessLevel(). A limitação de cota é de aproximadamente 10 MB. Considere usá-lo para armazenar variáveis globais em várias execuções de worker de serviço.
storage.managed
Os administradores podem usar um esquema e políticas corporativas para configurar as configurações de uma extensão de suporte em um ambiente gerenciado. Esta área de armazenamento é somente leitura.

Manifesto

Para usar a API Storage, declare a permissão "storage" no manifesto da extensão. Exemplo:

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

Uso

Os exemplos a seguir demonstram as APIs local, sync e session áreas de armazenamento:

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 saber mais sobre a área de armazenamento managed, consulte Manifesto para áreas de armazenamento.

Limites de armazenamento e restrição

Não pense em adicionar algo à API Storage como colocar coisas em um caminhão grande. Pense em adicionar ao armazenamento como se fosse colocar algo em um tubo. O tubo pode já ter material e até mesmo estar cheio. Sempre presuma um atraso entre o momento em que você adiciona armazenamento e o momento em que ele é realmente a gravação.

Para detalhes sobre as limitações da área de armazenamento e o que acontece quando elas são excedidas, consulte as informações de cota para sync, local e session.

Casos de uso

As seções a seguir demonstram casos de uso comuns para a API Storage.

Resposta síncrona a atualizações de armazenamento

Para acompanhar as mudanças feitas no armazenamento, adicione um listener ao evento onChanged. Quando algo é alterado no armazenamento, esse evento é disparado. O exemplo de código detecta estas mudanças:

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 levar essa ideia ainda mais longe. Neste exemplo, temos uma página de opções que permite que o usuário alterne um "modo de depuração" (implementação não mostrada aqui). A página de opções salva imediatamente as novas configurações em storage.sync, e o service worker usa storage.onChanged para aplicar a configuração o mais rápido possível.

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);
  }
});

Pré-carregamento assíncrono do armazenamento

Como os service workers nem sempre estão em execução, as extensões do Manifest V3 às vezes precisam carregar dados do armazenamento de forma assíncrona antes de executar os manipuladores de eventos. Para fazer isso, o fragmento a seguir usa um manipulador de eventos action.onClicked assíncrono que aguarda a população do global storageCache antes de executar a 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);
});

Exemplos de extensões

Para ver outras demonstrações da API Storage, explore um destes exemplos:

Tipos

AccessLevel

Chrome 102 ou versões mais recentes

O nível de acesso da área de armazenamento.

Enumeração

"TRUSTED_CONTEXTS"
Especifica contextos originados da própria extensão.

"TRUSTED_AND_UNTRUSTED_CONTEXTS"
especifica contextos originados fora da extensão.

StorageArea

Propriedades

  • onChanged

    Evento<functionvoidvoid>

    Chrome 73 ou superior

    Acionado quando um ou mais itens mudam.

    A função onChanged.addListener é semelhante a esta: 

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

    • callback

      função

      O parâmetro callback tem esta aparência: 

      (changes: object) => void

      • muda

        objeto

  • limpar

    void

    Promessa

    Remove todos os itens do armazenamento.

    A função clear tem esta aparência: 

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

    • callback

      função opcional

      O parâmetro callback tem este formato: 

      () => void

    • retorna

      Promessa<void>

      Chrome 88 e versões mais recentes

      As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

  • get

    void

    Promessa

    Recupera um ou mais itens do armazenamento.

    A função get é semelhante a esta: 

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

    • chaves

      string | string[] | objeto opcional

      Uma única chave a ser recuperada, uma lista de chaves a serem recuperadas ou um dicionário que especifica valores padrão (consulte a descrição do objeto). Uma lista ou um objeto vazio vai retornar um objeto de resultado vazio. Transmita null para receber todo o conteúdo do armazenamento.

    • callback

      função opcional

      O parâmetro callback tem esta aparência: 

      (items: object) => void

      • itens

        objeto

        Objeto com itens nos mapeamentos de chave-valor.

    • retorna

      Promise<object>

      Chrome 88 e versões mais recentes

      As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

  • getBytesInUse

    void

    Promessa

    Recebe a quantidade de espaço (em bytes) usada por um ou mais itens.

    A função getBytesInUse tem esta aparência: 

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

    • chaves

      string | string[] opcional

      Uma única chave ou uma lista de chaves para conferir o uso total. Uma lista vazia vai retornar 0. Transmita null para receber o uso total de todo o armazenamento.

    • callback

      função opcional

      O parâmetro callback tem este formato: 

      (bytesInUse: number) => void

      • bytesInUse

        number

        Quantidade de espaço em uso no armazenamento (em bytes).

    • retorna

      Promessa<número>

      Chrome 88 ou superior

      As promessas só são compatíveis com o Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

  • getKeys

    void

    Promessa Chrome 130 ou mais recente

    Recebe todas as chaves do armazenamento.

    A função getKeys é semelhante a esta: 

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

    • callback

      função opcional

      O parâmetro callback tem este formato: 

      (keys: string[]) => void

      • chaves

        string[]

        Matriz com chaves lidas do armazenamento.

    • retorna

      Promessa<string[]>

      As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

  • remover

    void

    Promessa

    Remove um ou mais itens do armazenamento.

    A função remove tem esta aparência: 

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

    • chaves

      string | string[]

      Uma única chave ou uma lista de chaves para itens a serem removidos.

    • callback

      função opcional

      O parâmetro callback tem este formato: 

      () => void

    • retorna

      Promessa<void>

      Chrome 88 e versões mais recentes

      As promessas só são compatíveis com o Manifesto V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

  • set

    void

    Promessa

    Define vários itens.

    A função set é semelhante a esta: 

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

    • itens

      objeto

      Um objeto que fornece cada par de chave-valor para atualizar o armazenamento. Os outros pares de chave-valor no armazenamento não vão ser afetados.

      Valores primitivos, como números, serão serializados conforme o esperado. Os valores com typeof "object" e "function" geralmente são serializados para {}, com exceção de Array (serialização como esperado), Date e Regex (serialização usando a representação String).

    • callback

      função opcional

      O parâmetro callback tem este formato: 

      () => void

    • retorna

      Promessa<void>

      Chrome 88 ou superior

      As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

  • setAccessLevel

    void

    Promessa Chrome 102 ou versões mais recentes

    Define o nível de acesso desejado para a área de armazenamento. O padrão será apenas contextos confiáveis.

    A função setAccessLevel tem esta aparência: 

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

    • accessOptions

      objeto

      • accessLevel

        AccessLevel

        O nível de acesso da área de armazenamento.

    • callback

      função opcional

      O parâmetro callback tem este formato: 

      () => void

    • retorna

      Promise<void>

      As promessas têm suporte apenas para o Manifest V3 e versões mais recentes. Outras plataformas precisam usar callbacks.

StorageChange

Propriedades

  • newValue

    qualquer opcional

    O novo valor do item, se houver um novo valor.

  • oldValue

    opcional

    O valor antigo do item, se houver.

Propriedades

local

Os itens na área de armazenamento de local são locais a cada máquina.

Tipo

StorageArea e objeto

Propriedades

  • QUOTA_BYTES

    10485760

    A quantidade máxima (em bytes) de dados que pode ser armazenada no local, conforme medida pela string JSON de cada valor mais o comprimento de cada chave. Esse valor será ignorado se a extensão tiver a permissão unlimitedStorage. As atualizações que poderiam exceder esse limite falham imediatamente e definem runtime.lastError ao usar um callback ou uma promessa rejeitada se você estiver usando async/await.

managed

Os itens na área de armazenamento do managed são definidos por uma política corporativa configurada pelo administrador do domínio e são somente leitura para a extensão. tentar modificar esse namespace resulta em erro. Para saber como configurar uma política, consulte Manifesto para áreas de armazenamento.

Tipo

StorageArea

session

Chrome 102 ou versões mais recentes MV3+

Os itens na área de armazenamento session são armazenados na memória e não são mantidos no disco.

Tipo

StorageArea e objeto

Propriedades

  • QUOTA_BYTES

    10485760

    A quantidade máxima (em bytes) de dados que podem ser armazenados na memória, medida pela estimativa do uso de memória alocado dinamicamente de cada valor e chave. As atualizações que causariam o excesso desse limite falham imediatamente e definem runtime.lastError ao usar um callback ou quando uma promessa é rejeitada.

sync

Os itens na área de armazenamento de sync são sincronizados com a Sincronização do Chrome.

Tipo

StorageArea e objeto

Propriedades

  • MAX_ITEMS

    512

    O número máximo de itens que podem ser guardados no armazenamento sincronizado. As atualizações que fazem com que esse limite seja excedido vão falhar imediatamente e definir runtime.lastError ao usar um callback ou quando uma promessa for rejeitada.

  • MAX_SUSTAINED_WRITE_OPERATIONS_PER_MINUTE

    1.000.000

    Descontinuado

    A API storage.sync não tem mais uma cota de operação de gravação sustentada.

  • MAX_WRITE_OPERATIONS_PER_HOUR

    1800

    O número máximo de operações set, remove ou clear que podem ser realizadas a cada hora. Isso é uma vez a cada dois segundos, um limite menor do que o limite de gravações por minuto de curto prazo.

    As atualizações que poderiam exceder esse limite falham imediatamente e definem runtime.lastError ao usar um callback ou quando uma promessa é rejeitada.

  • MAX_WRITE_OPERATIONS_PER_MINUTE

    120

    O número máximo de operações set, remove ou clear que podem ser executadas a cada minuto. Isso é 2 por segundo, oferecendo uma capacidade maior do que as gravações por hora em um período mais curto.

    As atualizações que causariam o excesso desse limite falham imediatamente e definem runtime.lastError ao usar um callback ou quando uma promessa é rejeitada.

  • QUOTA_BYTES

    102400

    A quantidade total máxima (em bytes) de dados que podem ser armazenados no armazenamento em sincronia, medida pela stringificação JSON de cada valor mais o comprimento de cada chave. As atualizações que poderiam exceder esse limite falham imediatamente e definem runtime.lastError ao usar um callback ou quando uma promessa é rejeitada.

  • QUOTA_BYTES_PER_ITEM

    8192

    O tamanho máximo (em bytes) de cada item individual no armazenamento sincronizado, conforme medido pela string JSON do valor mais o comprimento da chave. As atualizações que contêm itens acima desse limite vão falhar imediatamente e definir runtime.lastError ao usar um callback ou quando uma promessa for rejeitada.

Eventos

onChanged

chrome.storage.onChanged.addListener(
  callback: function,
)

Disparado quando um ou mais itens são alterados.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

    (changes: object, areaName: string) => void

    • muda

      objeto

    • areaName

      string