ls-cache0.2.3 • Public • Published
This is a library that emulates
memcache functions using HTML5
localStorage, so that you can cache data on the client and associate an expiration time with each piece of data. If the
localStorage limit (~5MB) is exceeded, it tries to create space by removing the items that are closest to expiring anyway. If
localStorage is not available at all in the browser, the library degrades by simply not caching and all cache requests return null.
Entries which have no expiry are never removed automatically from the cache.
Entries in the cache are optionally stored in a hierarchy of buckets, each of which is independant of the others.
Based on: [https://github.com/pamelafox/lscache]
The library exposes methods:
Stores the value in localStorage. Expires after specified number of minutes.
Retrieves specified value from localStorage, if not expired.
Object : The stored value.
Gets list of all keys in bucket
Array : Key names
Removes a value from localStorage.
Removes all ls-cache items in current bucket from localStorage without affecting other data.
Removes all ls-cache items in current bucket from localStorage and all sub-buckets
Creates a sub-bucket which is completely independent. However, its expirable items may be cleared to make room for more keys.
The interface should be familiar to those of you who have used
memcache, and should be easy to understand for those of you who haven't.
For example, you can store a string for 2 minutes using
You can then retrieve that string with
You can remove that string from the cache entirely with
You can remove all items from the cache entirely with
The library also takes care of serializing objects, so you can store more complex data:
And then when you retrieve it, you will get it back as an object:
If you have multiple instances of ls-cache running on the same domain, you can partition data in a certain bucket via:
bucket = lscache;bucket;lscache;lscache; //only removes 'path' which was set in the root bucket, not the sub-bucket
Buckets are nestable:
bucket = lscache;bucket2 = bucket;
lscache library should work in all browsers where
localStorage is supported.
A list of those is here:
npm i ls-cache