expired-localstorage

A library of cache based on localStorage that supports expired storage.

Usage no npm install needed!

<script type="module">
  import expiredLocalstorage from 'https://cdn.skypack.dev/expired-localstorage';
</script>

README

expired-localstorage

A library of cache based on localStorage that supports expired storage.

Installing

Using unpkg CDN

<script src="https://unpkg.com/expired-localstorage@1.0.1/index.js"></script>

Using npm

npm install expired-localstorage --save-dev

Usage

CommonJS usage

const LS = require('expired-localstorage')

Code in Javascript

//get data
LS.get('test');
//set data with expires time
LS.set('test', 123, 60000);
//remove data
LS.remove('test');
//clear all data
LS.clear();

Method Description

Get value from localStorage

LS.get(key)

  • {String} key -> key name.(required)

Set value by localStorage

LS.set(key, value, time)

  • {String} key -> key name.(required)
  • {Any} value -> data value.(required)
  • {Number} time -> expires time, unit is ms, such as passing 60000, that means 1 minute. No value, no expiration.(optional)

Remove data from localStorage

LS.remove(key)

  • {String} key -> key name.(required)

Clear all cached data

LS.clear()

License

expired-localstorage is MIT licensed.