Storeit is client side key/value storage system that publishes events. You can have multiple "stores". It supports different storage "providers" (ex: WebStorage) by means on dependency injection.
npm install storeit --save
You can also see StoreIt in action, live, on the Interwebs! Check out this fiddle. http://jsfiddle.net/donavon/Ljjxjbaz/
Storeit (constructor)_ Storeit(namespace:string, storageProvider:Provider, logger?:Function):Storeit _
In order to use StoreIt, you must instantiate an instance. It takes two required and one optional parameter as follows:
Example:
var Storeit = require("storeit");
var StoreitProvider = require("storeit-provider-webstorage");
var StoreitSerializer = require("storeit-serializer-json");
// Create a JSON serializer.
var jsonSerializer = new StoreitSerializer();
// Create a WebStorage provider that uses sessionStorage.
var providerOptions = {
localOrSessionStorage: window.sessionStorage,
allSerializers: [jsonSerializer],
metadataSerializerName: "JSONSerializer",
preferredItemSerializerName: "JSONSerializer"
};
var sessionStorageProvider = new StoreitProvider(providerOptions);
// Create a store.
var groceryStore = new Storeit("grocery", sessionStorageProvider, console.log.bind(console));
Storeit.EventNameStoreit.EventName is an enum containing the following actions:
Storeit.ActionStoreit.Action is an enum containing the following actions. These are part of the Result object returned by
store.set and store.delete.
ResultA Result object has the following properties:
Action enum values. Action is a property on the static Storeit.
ex: Storeit.Action.modified.store.set) or deleted (in the case of store.remove). This may or may not be the same as the value passed into store.set.
This may occur if you are setting a partial object. This is the value that would be returned on subsequent
calls to store.get.
In the case of a store.remove, value is the value that was deleted.store MethodsOnce you have a store object (calling new Store as discussed above), you can use the following methods:
store.has_ store.has(key:string):Boolean _
Returns true if the key is found.
store.set_ store.set(key:string, value:Object):Result _
This will add (if the key does not exist) or modify (if exists) an object in the store.
Where:
value may be an object, array, number, or a string.
You may pass a "partial" object that will "extend" into any existing object.Example (assuming key does not exist):
result = store.set("ID123", {foo:""});
// result.action = Storeit.Action.added
// result.key = "ID123"
// result.value is {foo:""}
result = store.set("ID123", {bar:""});
// result.action = Storeit.Action.modified
// result.key = "ID123"
// result.value is {foo:"", bar:""}
Note: This will also publish either an added or a modified event.
store.get_ store.get(key:string, defaultValue?:Any):Any _
This will get an object in the store that matches key. If no key exists, the defaultValue is returned.
If defaultValue is not specified, undefined is returned.
Where:
Example (assuming key does not exist):
value = store.get("ID123"); // value is undefined
value = store.get("ID123", {foo: "bar"}); // value is an object {foo: "bar"}
store.getAll_ store.getAll():Any[] _
Returns an array of all objects in the store.
store.getAllFilteredByProperty_ store.getAllFilteredByProperty(propName:string, propValue:Any):Any[] _
Returns an array of all objects in the store filters by property. StoreIt will use the propName as the key and if it matches propValue, the value wil be included in the array.
Example:
store.set("ID1", {id:"ID1", size:"large", color:"red"});
store.set("ID2", {id:"ID2", size:"small", color:"white"});
store.set("ID3", {id:"ID3", size:"large", color:"blue"});
store.set("ID4", {id:"ID4", size:"large", color:"red"});
var items = store.getAllFilteredByProperty("color", "red");
// [{id:"ID1", size:"large", color:"red"}, {id:"ID4", size:"large", color:"red"}]
store.remove_ store.remove(key:string):Result _
Removes a key from the store. If they key is not found, a "key doesn't exist" exception is thrown.
If the removal was successful, Result.value will contain the removed value.
Note: This will also publish a EventName.removed event.
store.delete_ store.delete(key:string):Result _
This is an ES5 friendly version of store.remove. Use only if your application will be running only on modern browser.
store.forEach_ store.forEach(callback:Function< key:string, value:Any >):Void _
Storeit will call callback once for each item in the store.
Example:
store.forEach(function (key, value) {
console.log('key="%s", value="%s"', key, value);
});
store.clear_ store.clear():Void _
Deletes all keys from the store.
Note: This will also publish a EventName.removed event for each item removed (you must set Option.publishRemoveOnClear) and a cleared event upon completion.
store.load_ store.load():Void _
Loads all keys from the store's data store. You MUST call load before using the store object.
Note: This will also publish a EventName.added event for each item loaded.
store.on_ store.on(eventName:EventName, callback:Function< value:Any, key:string >):Void _
Listens for published events.
Example:
var EventName = Storeit.EventName;
function onModified(value, key) {
console.log('You modified the key "%s"', key);
}
store.on(EventName.modified, onModified); // onModified will be called whenever any value in the store is modified.
store.once_ store.once(eventName:EventName, callback:Function< value:Any, key:string >):Void _
Same as store.on but automatically removes the listener after the first event.
store.off_ store.off(eventName:EventName, callback:Function):Void _
Stops listening to published events.
Example:
store.off(EventName.modified, onModified);
store Propertiesstore.keys_ store.keys:string[] _
An array representing every key in the store.
store.namespace_ store.namespace:string _
The namespace that you passed to the constructor.
store.options_ store.options:Options _
Where Options has the following properties:
true)EventName.removed events are published for each item when calling store.clear. (default = false)For use under MIT license
FAQs
A key/value storage system that publishes events.
The npm package storeit receives a total of 4 weekly downloads. As such, storeit popularity was classified as not popular.
We found that storeit demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Snyk's use of malicious npm packages for research raises ethical concerns, highlighting risks in public deployment, data exfiltration, and unauthorized testing.
Research
Security News
Socket researchers found several malicious npm packages typosquatting Chalk and Chokidar, targeting Node.js developers with kill switches and data theft.
Security News
pnpm 10 blocks lifecycle scripts by default to improve security, addressing supply chain attack risks but sparking debate over compatibility and workflow changes.