a reactive storage plugin for vue 👀🔭
the real reactive watcher for localStorge. I search a few days for a lib to watch the ls, but failed.
you can use this tiny ls wrapper which works well with vue.js.
you can use this as persistent data layer even instead of vuex.
TODO:
npm install vue-storage-watcher --save
import lsWatcher from 'vue-storage-watcher';
Vue.use(lsWatcher, { prefix: 'myproject_' });
storage type
this.$ls or this.$ss in Component context for localStorage/sessionStorage Vue.$ls or Vue.$ss in global.
I will list basic api just with ls.
this.$ls.set('token', 'abccc');
the value will be saved in storage with the prefix + key and emit the changes to all the subscribers.
you also can give the key an expire duration with the unit of ms
this.$ls.set('token', 'abccc', 3000);
the key will be expried in 3s, you will get null after that.
ttl will return -1 if one of the following scenarios happen:
else return the remaining lifetime with ms as the unit
this.$ls.ttl('token');
this.$ls.get('token', 'default');
get the value with a default return value if it's not existed
this.$ls.keys();
get all keys stored in the storage.
this.$ls.on('token', callback);
subscribe the key in the storage, will trigger the callback function if any changes happen.
the return value is the handler need to be used to unsubscribe
tricky there is an immediate options as a third args which will trigger cb immediate if set true
this.$ls.on('token', callback, true);
const handler = this.$ls.on('token', cb);
this.$ls.off('token', handler);
please make sure you unsubscribe beforeDestroy the component
this.$ls.remove('token');
remove will delete the key in storage and emit all the subscribers with null value
this.$ls.clear();
delete all the keys with your prefix. and all the subscribers will not receive changes any more
this.$ls.init();
init will set all your current localStorge keys into the plugins
and then you can use get and on mehtod to make them reactive
import lsWatcher from 'vue-storage-watcher';
Vue.use({ ...lsWatcher }, { prefix: 'myproject_' });
Vue.use({ ...lsWatcher }, { prefix: 'myproject_ss_', storage: 'session' });
// wather polyfill for IE 11
import 'core-js/fn/symbol';
import 'core-js/fn/map';
// wather polyfill for IE 11
import "core-js/fn/symbol"
import "core-js/fn/map"
Thanks goes to these wonderful people (emoji key):
Vincent Guo 💻 📖 🐛 |
---|
This project follows the all-contributors specification. Contributions of any kind welcome!