@yaoapp/storex
v1.1.4
Published
Keep the type of storage value unchanged and change array and object directly. Supports listening to changes and setting expires.
Downloads
16
Maintainers
Readme
@yaoapp/storex
English | 中文
A more convenient way to use storage through proxy.
try it on codesandbox.
Install
npm i @yaoapp/storex
Features
Base
Keep the type of storage value unchanged and change array and object directly.
import { local, session } from '@yaoapp/storex';
local.test = 'Hello @yaoapp/storex'; // works
delete local.test; // works
// number
local.test = 0;
local.test === 0; // true
// boolean
local.test = false;
local.test === false; // true
// undefined
local.test = undefined;
local.test === undefined; // true
// null
local.test = null;
local.test === null; // true
// object
local.test = { hello: 'world' };
local.test.hello = '@yaoapp/storex'; // works
// array
local.test = ['hello'];
local.test.push('@yaoapp/storex'); // works
local.test.length // 2
// Date
local.test = new Date('2000-01-01T00:00:00.000Z');
local.test.getTime() === 946684800000; // true
// RegExp
local.test = /d(b+)d/g;
local.test.test("cdbbdbsbz"); // true
// function
local.test = function() {
return 'Hello @yaoapp/storex!';
};
local.test() === 'Hello @yaoapp/storex!'; // true
Subscribe
listen to the changes.
import { local } from '@yaoapp/storex';
local.on('test', function(newVal, oldVal) {
console.log('test', newVal, oldVal);
});
local.on('test.a', function(newVal, oldVal) {
console.log('test.a', newVal, oldVal);
});
local.test = {};
// test {} undefined
local.test.a = 1;
// test.a 1 undefined
on
Subscribe to an item.
key
: the name of the item to subscribe to. Supportobj.a
forObject
andlist[0]
forArray
, and alsoArray
length.callback
: the function to call when the item is changed. IncludesnewValue
andoldValue
.
once
Subscribe to an item only once.
key
: the name of the item to subscribe to. Supportobj.a
forObject
andlist[0]
forArray
.callback
: the function to call when the item is changed. IncludesnewValue
andoldValue
.
off
Unsubscribe from an item or all items.
key(optional)
: the name of the item to unsubscribe from. If no key is provided, it unsubscribes you from all items.callback(optional)
: the function used when binding to the item. If no callback is provided, it unsubscribes you from all functions binding to the item.
Expired
set expires for items.
import { local } from '@yaoapp/storex';
local.test = 'hello @yaoapp/storex';
local.setExpires('test', Date.now() + 10000);
// within 10's
local.test // 'hello @yaoapp/storex'
// after 10's
local.test // undefined
The expires is saved to localStorage. So no matter how you reload it within 10's, the value still exists. But after 10's, it has been removed.
setExpires
set expires for an item.
key
: the name of the item to set expires.expires
: acceptstring
、number
andDate
.
getExpires
return the expires(Date
) of the item.
key
: the name of the item that has set expires.
removeExpires
cancel the expires of the item.
key
: the name of the item that has set expires.