Skip to content

Web Storage Cache: A JavaScript cache utilizing web browser storage technologies (localStorage/sessionStorage)

License

Notifications You must be signed in to change notification settings

howardchung/wscache

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 

Repository files navigation

wscache

Web Storage Cache: A JavaScript cache utilizing web browser storage technologies (localStorage/sessionStorage)

Features

  • Lightweight
  • Automatic key expiry
  • Configurable cleanup interval
  • Configurable storage (localStorage/sessionStorage)

Use Cases

  • Save data from remote APIs in the cache to avoid excessive network calls
  • Save some temporary user setting or data that you want to expire automatically after a while

Usage

npm install wscache

Example

import wscache from 'wscache';

const cache = wscache({ 
  storeName: 'sessionStorage', // default sessionStorage, also works with localStorage
  cleanupIntervalSeconds: 5 // default 30
});

// Set an item with expiry
cache.setItem('key', 'value', 10);

// Get an item
cache.getItem('key'); // value

// Wait 15 seconds
setTimeout(() => {
  cache.getItem('key'); // null
}, 15000);

// Remove an item
cache.setItem('key2', 'value2');
cache.removeItem('key2');
cache.getItem('key2'); // null;

}

About

Web Storage Cache: A JavaScript cache utilizing web browser storage technologies (localStorage/sessionStorage)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published