# webext-storage-cache [![](https://img.shields.io/npm/v/webext-storage-cache.svg)](https://www.npmjs.com/package/webext-storage-cache) > Cache values in your Web Extension and clear them on expiration. Also includes a memoize-like API to cache any function results automatically. - Browsers: Chrome, Firefox, and Safari - Manifest: v3 - Context: They can be called from any context that has access to the `chrome.storage` APIs - Permissions: (with attached "reasons" for submission to the Chrome Web Store) - `storage`: "The extension caches some values into the local storage" - `alarms`: "The extension automatically clears its expired storage at certain intervals" ## Install You can download the [standalone bundle](https://bundle.fregante.com/?pkg=webext-storage-cache&global=window) and include it in your `manifest.json`. Or use `npm`: ```sh npm install webext-storage-cache ``` ## Usage This module requires the `storage` permission and it’s suggested to also use `alarms` to safely schedule cache purging: ```json5 /* manifest.json */ { "permissions": [ "storage", "alarms" ], "background": { "scripts": [ /* Remember to include/import it in the background to enable expired cache purging */ "webext-storage-cache.js" ] } } ``` ```js import {CachedValue} from 'webext-storage-cache'; const item = new CachedValue('unique', { maxAge: { days: 3, }, }); (async () => { if (!(await item.isCached())) { const cachableItem = await someFunction(); await item.set(cachableItem); } console.log(await item.get()); })(); ``` The same code could also be written more effectively with `CachedFunction`: ```js import {CachedFunction} from 'webext-storage-cache'; const cachedFunction = new CachedFunction('unique', { updater: someFunction, maxAge: { days: 3, }, }); (async () => { console.log(await cachedFunction()); })(); ``` ## API - [CachedValue](./source/cached-value.md) - A simple API getter/setter - [CachedMap](./source/cached-map.md) - A Map-like API to cache multiple values under the same key. - [CachedFunction](./source/cached-function.md) - A memoize-like API to cache your function calls without manually calling `isCached`/`get`/`set` - `globalCache` - Global helpers, documented below ### globalCache.clear() Clears the cache. This is a special method that acts on the entire cache of the extension. ```js import {globalCache} from 'webext-storage-cache'; document.querySelector('.options .clear-cache').addEventListener('click', async () => { await globalCache.clear() }) ``` ## Related - [webext-detect](https://github.com/fregante/webext-detect) - Detects where the current browser extension code is being run. - [webext-options-sync](https://github.com/fregante/webext-options-sync) - Helps you manage and autosave your extension's options. - [webext-base-css](https://github.com/fregante/webext-base-css) - Extremely minimal stylesheet/setup for Web Extensions’ options pages (also dark mode) - [webext-dynamic-content-scripts](https://github.com/fregante/webext-dynamic-content-scripts) - Automatically registers your content_scripts on domains added via permission.request - [More…](https://github.com/fregante/webext-fun) ## License MIT © [Federico Brigante](https://fregante.com)