StorageArea

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

Методы

clear()

browser.storage.StorageArea.clear(): Promise<void>

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

Возвраты

  • Promise<void>

    Chrome 95 и более поздних версий browser.* начиная с Chrome 148

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

get()

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

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

Параметры

  • ключи

    string | string[] | object optional

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

Возвраты

  • Promise<object>

    Chrome 95 и более поздних версий browser.* начиная с Chrome 148

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

getBytesInUse()

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

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

Параметры

  • ключи

    string | string[] optional

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

Возвраты

  • Promise<number>

    Chrome 95 и более поздних версий browser.* начиная с Chrome 148

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

getKeys()

Chrome 130+ browser.* начиная с Chrome 148 
browser.storage.StorageArea.getKeys(): Promise<string[]>

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

Возвраты

  • Promise<string[]>

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

remove()

browser.storage.StorageArea.remove(
  keys: string | string[],
): Promise<void>

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

Параметры

  • ключи

    string | string[]

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

Возвраты

  • Promise<void>

    Chrome 95 и более поздних версий browser.* начиная с Chrome 148

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

set()

browser.storage.StorageArea.set(
  items: object,
): Promise<void>

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

Параметры

  • items

    Объект

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

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

Возвраты

  • Promise<void>

    Chrome 95 и более поздних версий browser.* начиная с Chrome 148

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

setAccessLevel()

Chrome 102 и более поздних версий browser.* начиная с Chrome 148 
browser.storage.StorageArea.setAccessLevel(
  accessOptions: object,
): Promise<void>

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

Параметры

  • accessOptions

    Объект

    • accessLevel

      AccessLevel

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

Возвраты

  • Promise<void>

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

События

onChanged

Chrome 73 и более поздних версий browser.* начиная с Chrome 148 
browser.storage.StorageArea.onChanged.addListener(
  callback: function,
)

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

Параметры

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

    function

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

    (changes: object) => void

    • Изменения

      Объект