ocbesbn-cache

ocbesbn-cache

This module provides a cache front-end for unified cache access independently from the underlying cache technology. By default it ships with three cache providers: dummy, memory and redis.

To have a look at the full API, please visit the related wiki page.

Minimum setup

First got to your local code directory and run:

npm install ocbesbn-cache

If you are using the redis back-end, you'll need to have access to a running Consul server to get your endpoint configuration and a Redis server to connect to.

If all this is set up, go to you code and add the following command:

const Cache = require('ocbesbn-cache');

var cache = new Cache(); // Memory driver

cache.put('hello', 'world').then(() => cache.get('hello')).then(console.log);

Default configuration

The default configuration object provides hints about what the module's standard behavior is like. In order to set plug-in (driver) specific configurations, you may add a sub-key to the configuration having the same name as the driver property you set and assign a configuration object there.

{
    driver : 'memory',
    keyPrefix : '',
    defaultExpire : 600,
    pluginDirectory : 'plugins'
}

Example including memory driver configuration:

const Cache = require('ocbesbn-cache');

var cache = new Cache({
    driver : 'memory',
    memory : {
        checkPeriod : 10
    }
});