@dsabre/local-storage-cache

Local Storage Cache

Npm module for use the local storage as a cache.

Dependencies

Moment.js

Installation

  npm i @dsabre/local-storage-cache

Methods

The class exposes these methods:

setBucket(bucketName: string)

Set the bucket name for the cache, if not used the default bucket name cache is used

---

set(cid: string, value: any, expirationInMinutes: number)

Set a cache item in bucket.

• cid: is the cache id for this item,
• value: contain what you want to be saved,
• expirationInMinutes: pass here the amount of minutes while you cache item is valid.

---

get(cid: string)

Get a cache item from bucket.

• cid: is the cache id for this item.

---

remove(cid: string)

Remove a cache item from bucket.

• cid: is the cache id for this item.

---

flush()

Flush the entire bucket from local storage.

---

flushExpired()

Flush expired items from bucket.

Thanks

This class is inspired by:

lscache

License

MIT