js-local-cache

Local Cache

Local cache will cache your application data very useful for API responses to cache which reduces server hits. Easy to use and Easy to understand

---

Basic useful feature list:

• Cache any type of data on js level
• Auto clear in given time with each data [default 5 mint]
• group base cache
• Static Cache overall the application
• Extra parameter provided to search, divide same identifier and key with paginated data

installation

npm install js-local-cache --save

Class Functions

Functions List:

setData(key, data, cachedTimeout, group, extraParam)
getData(key, group, extraParam)
clearData(key, group, extraParam)
clearGroup(group)
clearAllCache() // Use always when logged out

Params Types:

Param	Type	Required	Default
key	String Or Integer / unique	Required
data	Any	Required
cachedTimeout	Miliseconds	Optional	300000 //5 mints
group	String Or Integer	Optional	'default'
extraParam	String Or Integer	Optional	null

Coding Example

import Cache from 'js-local-cache';
 
function getCustomerList(token, pageNum, forceUpdate){
// token can be used as unique key or any thing you
// in case forceUpdate
const cacheData = Cache.getData(token, pageNum, 'customer');
if(forceUpdate){
  Cache.clearData(token, 'customer', pageNum);
   // OR
  Cache.clearGroup('customer');
}
if(cacheData && !forceUpdate){
  return new Promise((resolve) => {
    resolve(cacheData);
  });
}
 
  return promise((resolve, reject) => {
    request(url).end(response => {
      Cache.setData(token, response, 100000, 'customer', pageNum);
      // this data will be wipedout after 100000 miliseconds
      resolve(response);
    });
  });
}

Unit Tests Unit test provided with 100% Coverage

npm run test

License

MIT