README.md

save-state

Use your favourite data store like In-Memory cache, MongoDB, Redis and Elastic without worrying about the internal implementations.

NPM https://www.npmjs.com/package/save-state

Installation

npm install save-state

Usage

Example

const Store = require("save-state");
const client = Store.createClient();

// register listener
client.on(HealthEvents.Ready, (status) => {
    console.log(`Store connection ${status ? "ready" : "failure"}`);
});

client.connect();

createClient takes optional data store config, with no config passed returns In-Memory Store Client

Examples below

• Mongo Client

const client = Store.createClient(
    {
        mongo: {
            collection: "example-collection",
            db: "example",
            url: "mongodb://localhost:27017",
        },
    });

• Redis Client

const client = Store.createClient(
    {
        redis: {
            url: "redis://localhost:6379/0",
        },
    });

• Elasticsearch Client

const client = Store.createClient(
    {
        redis : {
            url: "localhost:9200",
            index: "example-index",
            type: "example-type",
         },
    });

set API

set takes JSON document whose key is string and value is a document. Can pass more than one document to be saved at once.

// save document
client.set({ boo : {  a : 1}});

// save multiple documents
client.set({
    foo : { b : 23 },
    eoo : { c : { d : 45 } },
});

// save multiple documents
client.set({
             "key-1" : {  ...document-1 },
             "key-2" : {  ...document-2 },
             // ..
             "key-n" : {  ...document-n },
});

client.set({ yoo: "not a document"}) // throws error

get API

get takes array of strings (keys) to fetch documents from data store.

// retrieve document
client.get(["key-1"]);

// retrieve multiple documents
client.get(["key-1", "key-2"]);

remove API

remove takes a string (key) to delete document from data store.

// delete document
client.remove("key-1");

removeAll API

removeAll deletes all document from data store.

// delete all documents
client.removeAll();

• Developer notes on local setup