kiper
Keep objects available everywhere in nodejs application
How to use
First you need to install kiper
using npm:
npm install kiper --save
Then, use kiper in your project:
const kiper = ; // somewhere keep an assetkiper; // somewhere you got it backlet value = kiper;console;
API Usage
.keep(key: string, value: object)
Method: Keep an object in kiper
Added in:v0.0.1
Alias:set
kiper;
.keep(key: string, value: object, ttl: int, timeout: function)
Method: Keep an object for a period of time
Added in:v0.1.0
Alias:set
kiper;// output: bar foor
.get(key: string)
Method: Get an object from kiper
Added in:v0.0.1
kiper;// returns: bar
.get(validator: function)
Method: Get an object from kiper by pass a validator function
Added in:v0.0.2
kiper;// returns: bar
.remove(key: string)
Method: Remove an object out of kiper
Added in:v0.1.0
kiper;// returns: bar
.retire()
Method: Stop interval checking, free memory and release objects
Added in:v0.1.0
kiper;
.touch(key)
Method: Repair the last time usage
Added in:v1.0.0
kiper;
.watch(key, callback)
Method: Watch a key, if its value changes then a callback will be called
Added in:v1.0.0
// keep an asset and return an obserable object let baz = kiper; // watch the keykiper; // baz lost one goldbazgold = 999// baz has new silversbazsilver = 1000// baz lost all goldsdelete bazgold
.on(event, listener)
Method: Listen an event which emit from kiper
Added in:v1.0.0
kiper;kiper
.once(event, listener)
Method: Listen an event once which emit from kiper
Added in:v1.0.0
kiper;kiper
License
MIT