Зона хранения

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

Методы

clear()

Обещать
chrome.storage.StorageArea.clear(
  callback?: function,
): Promise<void>

Удаляет все товары со склада.

Параметры

  • перезвонить

    функция необязательна

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

    () => void

Возвраты

  • Обещание<пустота>

    Chrome 95+

    Поддержка промисов доступна только для Manifest V3 и более поздних версий; для других платформ необходимо использовать колбэки.

get()

Обещать
chrome.storage.StorageArea.get(
  keys?: string | string[] | object,
  callback?: function,
): Promise<object>

Извлекает один или несколько предметов со склада.

Параметры

  • ключи

    строка | строка[] | объект (необязательно)

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

  • перезвонить

    функция необязательна

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

    (items: object) => void

    • предметы

      объект

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

Возвраты

  • Promise<object>

    Chrome 95+

    Поддержка промисов доступна только для Manifest V3 и более поздних версий; для других платформ необходимо использовать колбэки.

getBytesInUse()

Обещать
chrome.storage.StorageArea.getBytesInUse(
  keys?: string | string[],
  callback?: function,
): Promise<number>

Получает объем пространства (в байтах), используемого одним или несколькими элементами.

Параметры

  • ключи

    строка | строка[] необязательно

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

  • перезвонить

    функция необязательна

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

    (bytesInUse: number) => void

    • байтыВИспользовании

      число

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

Возвраты

  • Обещание<число>

    Chrome 95+

    Поддержка промисов доступна только для Manifest V3 и более поздних версий; для других платформ необходимо использовать колбэки.

getKeys()

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

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

Параметры

  • перезвонить

    функция необязательна

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

    (keys: string[]) => void

    • ключи

      нить[]

      Массив с ключами, считанными из памяти.

Возвраты

  • Promise<string[]>

    Поддержка промисов доступна только для Manifest V3 и более поздних версий; для других платформ необходимо использовать колбэки.

remove()

Обещать
chrome.storage.StorageArea.remove(
  keys: string | string[],
  callback?: function,
): Promise<void>

Удаляет один или несколько предметов со склада.

Параметры

  • ключи

    строка | строка[]

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

  • перезвонить

    функция необязательна

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

    () => void

Возвраты

  • Обещание<пустота>

    Chrome 95+

    Поддержка промисов доступна только для Manifest V3 и более поздних версий; для других платформ необходимо использовать колбэки.

set()

Обещать
chrome.storage.StorageArea.set(
  items: object,
  callback?: function,
): Promise<void>

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

Параметры

  • предметы

    объект

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

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

  • перезвонить

    функция необязательна

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

    () => void

Возвраты

  • Обещание<пустота>

    Chrome 95+

    Поддержка промисов доступна только для Manifest V3 и более поздних версий; для других платформ необходимо использовать колбэки.

setAccessLevel()

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

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

Параметры

  • accessOptions

    объект

  • перезвонить

    функция необязательна

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

    () => void

Возвраты

  • Обещание<пустота>

    Поддержка промисов доступна только для Manifest V3 и более поздних версий; для других платформ необходимо использовать колбэки.

События

onChanged

Chrome 73+
chrome.storage.StorageArea.onChanged.addListener(
  callback: function,
)

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

Параметры

  • перезвонить

    функция

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

    (changes: object) => void

    • изменения

      объект