StorageArea

refresh date: 2026-09-25 robots: noindex

Интерфейс StorageArea используется в chrome.storage API.

Методы

clear()

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

Удаляет все элементы из хранилища.

Параметры

  • обратный вызов

    function необязательно

    Параметр callback выглядит следующим образом: 

    () => void

Возвраты

  • Promise<void>

    Chrome 95 и более поздних версий;

    Объект Promise, который распознается, если вставка выполнена успешно, и отклоняется в случае ошибки.

    Объекты Promise поддерживаются только в Manifest V3 и более поздних версиях. На других платформах нужно использовать обратные вызовы.

get()

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

Получает один или несколько элементов из хранилища.

Параметры

  • ключи

    string | string[] | object optional

    Один ключ, список ключей или словарь со значениями по умолчанию (см. описание объекта). Пустой список или объект возвращает пустой объект результата. Передайте null, чтобы получить все содержимое хранилища.

  • обратный вызов

    function необязательно

    Параметр callback выглядит следующим образом: 

    (items: object) => void

    • items

      Объект

      Объект с элементами в сопоставлениях пар "ключ-значение".

Возвраты

  • Promise<object>

    Chrome 95 и более поздних версий;

    Объект Promise, который распознается как объект, содержащий карту "ключ-значение" для запрошенных элементов, или отклоняется в случае ошибки.

    Объекты Promise поддерживаются только в Manifest V3 и более поздних версиях. На других платформах нужно использовать обратные вызовы.

getBytesInUse()

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

Возвращает объем пространства (в байтах), используемый одним или несколькими объектами.

Параметры

  • ключи

    string | string[] optional

    Один ключ или список ключей, для которых нужно получить данные об использовании. Если список пуст, возвращает 0. Передайте null, чтобы получить общий объем используемого хранилища.

  • обратный вызов

    function необязательно

    Параметр callback выглядит следующим образом: 

    (bytesInUse: number) => void

    • bytesInUse

      число

      Объем используемого пространства в хранилище (в байтах).

Возвраты

  • Promise<number>

    Chrome 95 и более поздних версий

    Promise, который разрешается с объемом пространства, используемого хранилищем, или отклоняется в случае сбоя.

    Объекты Promise поддерживаются только в Manifest V3 и более поздних версиях. На других платформах нужно использовать обратные вызовы.

getKeys()

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

Получает все ключи из хранилища.

Параметры

  • обратный вызов

    function необязательно

    Параметр callback выглядит следующим образом: 

    (keys: string[]) => void

    • ключи

      string[]

      Массив с ключами, считанными из хранилища.

Возвраты

  • Promise<string[]>

    Объект Promise, который распознается с ключами хранилища или отклоняется в случае ошибки.

    Объекты Promise поддерживаются только в Manifest V3 и более поздних версиях. На других платформах нужно использовать обратные вызовы.

remove()

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

Удаляет один или несколько объектов из хранилища.

Параметры

  • ключи

    string | string[]

    Один ключ или список ключей для элементов, которые нужно удалить.

  • обратный вызов

    function необязательно

    Параметр callback выглядит следующим образом: 

    () => void

Возвраты

  • Promise<void>

    Chrome 95 и более поздних версий;

    Объект Promise, который распознается, если вставка выполнена успешно, и отклоняется в случае ошибки.

    Объекты Promise поддерживаются только в Manifest V3 и более поздних версиях. На других платформах нужно использовать обратные вызовы.

set()

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

Задает несколько элементов.

Параметры

  • items

    Объект

    Объект, который предоставляет каждую пару "ключ-значение" для обновления хранилища. Другие пары "ключ-значение" в хранилище затронуты не будут.

    Простые значения, например числа, будут сериализованы ожидаемым образом. Значения с typeof "object" и "function" обычно сериализуются в {}, за исключением Array (сериализуется как ожидалось), Date и Regex (сериализуются с использованием их представления String).

  • обратный вызов

    function необязательно

    Параметр callback выглядит следующим образом: 

    () => void

Возвраты

  • Promise<void>

    Chrome 95 и более поздних версий

    Объект Promise, который распознается, если вставка выполнена успешно, и отклоняется в случае ошибки.

    Объекты Promise поддерживаются только в Manifest V3 и более поздних версиях. На других платформах нужно использовать обратные вызовы.

setAccessLevel()

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

Задает уровень доступа к хранилищу. По умолчанию хранилище session доступно только для доверенных контекстов (страниц расширений и сервисных скриптов), а хранилища managed, local и sync – как для доверенных, так и для недоверенных контекстов.

Параметры

  • accessOptions

    Объект

    • accessLevel

      AccessLevel

      Уровень доступа к хранилищу.

  • обратный вызов

    function необязательно

    Параметр callback выглядит следующим образом: 

    () => void

Возвраты

  • Promise<void>

    Объект Promise, который распознается, если вставка выполнена успешно, и отклоняется в случае ошибки.

    Объекты Promise поддерживаются только в Manifest V3 и более поздних версиях. На других платформах нужно использовать обратные вызовы.

События

onChanged

Chrome 73 и более поздних версий; 
chrome.storage.StorageArea.onChanged.addListener(
  callback: function,
)

Срабатывает, когда изменяется один или несколько элементов.

Параметры

  • обратный вызов

    function

    Параметр callback выглядит следующим образом: 

    (changes: object) => void

    • Изменения

      Объект