StorageArea

A interface StorageArea é usada pela API chrome.storage.

Métodos

clear()

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

Remove todos os itens do armazenamento.

Parâmetros

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promessa<void>

    Chrome 95 ou mais recente

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

get()

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

Recebe um ou mais itens do armazenamento.

Parâmetros

  • chaves

    string | string[] | object opcional

    Uma única chave, uma lista de chaves 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 optional

    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 95 ou mais recente

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

getBytesInUse()

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

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

Parâmetros

  • chaves

    string | string[] opcional

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

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    (bytesInUse: number) => void

    • bytesInUse

      número

      Quantidade de espaço em uso no armazenamento, em bytes.

Retorna

  • Promise<number>

    Chrome 95 ou mais recente

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

getKeys()

Promise Chrome 130 ou mais recente 
chrome.storage.StorageArea.getKeys(
  callback?: function,
): Promise<string[]>

Recebe todas as chaves do armazenamento.

Parâmetros

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    (keys: string[]) => void

    • chaves

      string[]

      Matriz com chaves lidas do armazenamento.

Retorna

  • Promise<string[]>

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

remove()

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

Remove um ou mais itens do armazenamento.

Parâmetros

  • chaves

    string | string[]

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

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promessa<void>

    Chrome 95 ou mais recente

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

set()

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

Define vários itens.

Parâmetros

  • itens

    objeto

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

    Valores primitivos, como números, serão serializados conforme o esperado. Valores com um typeof "object" e "function" geralmente são serializados como {}, exceto Array (serializado como esperado), Date e Regex (serializados usando a representação String).

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promessa<void>

    Chrome 95 ou mais recente

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

setAccessLevel()

Promise Chrome 102 ou mais recente 
chrome.storage.StorageArea.setAccessLevel(
  accessOptions: object,
  callback?: function,
): Promise<void>

Define o nível de acesso desejado para a área de armazenamento. Por padrão, o armazenamento session é restrito a contextos confiáveis (páginas de extensão e service workers), enquanto o armazenamento managed, local e sync permite acesso de contextos confiáveis e não confiáveis.

Parâmetros

  • accessOptions

    objeto

    • accessLevel

      AccessLevel

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

  • callback

    função optional

    O parâmetro callback tem esta aparência: 

    () => void

Retorna

  • Promessa<void>

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

Eventos

onChanged

Chrome 73 ou mais recente 
chrome.storage.StorageArea.onChanged.addListener(
  callback: function,
)

Disparado quando um ou mais itens mudam.

Parâmetros

  • callback

    função

    O parâmetro callback tem esta aparência: 

    (changes: object) => void

    • muda

      objeto