@algolia/cache-browser-local-storage

What is @algolia/cache-browser-local-storage?

@algolia/cache-browser-local-storage is an npm package that provides a caching mechanism using the browser's local storage. It is designed to store and retrieve data efficiently, making it useful for applications that require persistent client-side caching.

What are @algolia/cache-browser-local-storage's main functionalities?

Set Cache

This feature allows you to set a value in the local storage cache with an optional expiration time. The code sample demonstrates how to set a key-value pair in the cache.

const { createBrowserLocalStorageCache } = require('@algolia/cache-browser-local-storage');
const cache = createBrowserLocalStorageCache();

cache.set('key', 'value', { expiresIn: 3600 }).then(() => {
  console.log('Value set in cache');
});

Get Cache

This feature allows you to retrieve a value from the local storage cache using a key. The code sample demonstrates how to get a value from the cache.

const { createBrowserLocalStorageCache } = require('@algolia/cache-browser-local-storage');
const cache = createBrowserLocalStorageCache();

cache.get('key').then(value => {
  console.log('Cached value:', value);
});

Delete Cache

This feature allows you to delete a value from the local storage cache using a key. The code sample demonstrates how to delete a key-value pair from the cache.

const { createBrowserLocalStorageCache } = require('@algolia/cache-browser-local-storage');
const cache = createBrowserLocalStorageCache();

cache.delete('key').then(() => {
  console.log('Value deleted from cache');
});

Other packages similar to @algolia/cache-browser-local-storage

localforage

localforage is a JavaScript library that improves the offline experience of your web app by using asynchronous storage (IndexedDB or WebSQL) with a simple, localStorage-like API. It offers more storage capacity and better performance compared to @algolia/cache-browser-local-storage.

idb-keyval

idb-keyval is a small library that provides a simple key-value store backed by IndexedDB. It is lightweight and offers a promise-based API for storing and retrieving data, making it a good alternative to @algolia/cache-browser-local-storage for more complex storage needs.

store.js

store.js is a simple and lightweight library for cross-browser storage. It automatically falls back to the best available storage mechanism (localStorage, IndexedDB, WebSQL) and provides a straightforward API for storing and retrieving data. It is similar to @algolia/cache-browser-local-storage but offers more flexibility in terms of storage options.

README

The README file is missing

Changelog

v4.14.0

• chore: mention next version in README (#1413) (100d180), closes #1413
• feat(fetch-requester): add @algolia/requester-fetch (#1411) (7b62403), closes #1411