storage.local

Представляет область хранения local. Элементы в хранилище local локальны для машины, на которой установлен расширение.

Браузер может ограничивать объем данных, которые расширение может хранить в локальном хранилище. Например:

В Chrome расширение ограничено хранением 5 МБ данных с помощью этого API, если у него нет разрешения "unlimitedStorage".
В Firefox объем данных, которые может хранить расширение, подчиняется тем же ограничениям хранилища, что и базы данных IndexedDB. Расширениям, которые намерены хранить больше данных, чем этот лимит, необходимо разрешение "unlimitedStorage". Однако расширения с разрешением "unlimitedStorage" могут получить ошибку превышения квоты, когда дисковое пространство, используемое хранилищем, превысит общий лимит.

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

Также в Firefox можно предотвратить очистку локального хранилища при удалении расширения, посетив about:config и установив эти настройки браузера на true: "keepUuidOnUninstall" и "keepStorageOnUninstall". Эта функция предназначена для помощи разработчикам в тестировании своих расширений. Сами расширения не могут изменить эти настройки.

Хотя это API похоже на Window.localStorage, рекомендуется не использовать Window.localStorage в коде расширения. Firefox очищает данные, сохранённые расширениями с помощью API localStorage в различных сценариях, когда пользователи очищают свою историю и данные просмотра по соображениям конфиденциальности. Данные, сохраненные с помощью API storage.local правильно сохраняются в этих сценариях.

Методы

Объект local реализует методы, определенные для типа storage.StorageArea:

storage.local.get(): Извлекает один или несколько элементов из области хранения.
storage.local.getBytesInUse(): Получает объем дискового пространства (в байтах), используемого одним или несколькими элементами в области хранения.
storage.local.set(): Хранит один или несколько элементов в области хранения. Если элемент существует, его значение обновляется.
storage.local.remove(): Удаляет один или несколько элементов из области хранения.
storage.local.clear(): Удаляет все элементы из области хранения.

События

Объект local реализует события, определенные для типа storage.StorageArea:

storage.local.onChanged: Вызывается, когда один или несколько элементов в области хранения изменяются.

Примеры расширений

Совместимость с браузерами

	Рабочий стол						Мобильные устройства
	Chrome	Edge	Firefox	Internet Explorer	Opera	Safari	WebView Android	Chrome Android	Firefox для Android	Opera Android	Safari на iOS	Samsung Internet
`local`	Да	14	45 API хранилища поддерживается в скриптах содержимого с версии 48.	?	Да	14	?	?	48	?	15	?

Примечание: Это API основано на API chrome.storage Chromium. Данная документация взята из storage.json кода Chromium.

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/storage/local