Skip to content

klren0312/localStorage_hasExpiration

Repository files navigation

zstorage

the localStorage that has expired time

NPM version npm FOSSA Status codecov

Install

$ npm install zstorage --save

Test

$ git clone https://github.com/klren0312/localStorage_hasExpiration.git
$ cd localStorage_hasExpiration
$ npm install
$ npm run test

Use

you can see example in ./index.html

import Storage from 'zstorage'
Storage.set('test', {t:1,b:2}, 5)
console.log('current,', Storage.get('test'))
setTimeout(() => console.log('after 5s,', Storage.get('test')), 5000)

Api

get (key)

get the value by key from localStorage

param: 
  key
return:
  null (expired)
  value (not expired)

set (key, value, expired_second)

set the localStorage, with key, value and expired_second(unit: s)

Tips: You'll not use JSON.stringify() to stringify Object or Array

param:
  key
  value
  expired_second
return

remove (key)

remove the value by key from localStorage

param:
  key
return

clear ()

clear all values from localStorage

License

FOSSA Status