cache-manager

Cache module for Node.js

node-cache-manager

Flexible NodeJS cache module

A cache module for nodejs that allows easy wrapping of functions in cache, tiered caches, and a consistent interface.

  • Easy way to wrap any function in cache.
  • Tiered caches -- data gets stored in each cache and fetched from the highest priority cache(s) first.
  • Use any cache you want, as long as it has the same API.
  • 100% test coverage via mocha, istanbul, and sinon.

See the Express.js cache-manager example app to see how to use node-cache-manager in your applications.

npm install cache-manager

First, it includes a wrap function that lets you wrap any function in cache. (Note, this was inspired by node-caching.) This is probably the feature you're looking for. As an example, where you might have to do this:

function getCachedUser(idcb) {
    memoryCache.get(id, function (errresult) {
        if (err) { return cb(err); }
 
        if (result) {
            return cb(null, result);
        }
 
        getUser(id, function (errresult) {
            if (err) { return cb(err); }
            memoryCache.set(id, result);
            cb(null, result);
        });
    });
}

... you can instead use the wrap function:

function getCachedUser(idcb) {
    memoryCache.wrap(id, function (cacheCallback) {
        getUser(id, cacheCallback);
    }, {ttl: ttl}, cb);
}

Second, node-cache-manager features a built-in memory cache (using node-lru-cache), with the standard functions you'd expect in most caches:

set(key, val, ttl, cb)
get(key, cb)
del(key, cb)

Third, node-cache-manager lets you set up a tiered cache strategy. This may be of limited use in most cases, but imagine a scenario where you expect tons of traffic, and don't want to hit your primary cache (like Redis) for every request. You decide to store the most commonly-requested data in an in-memory cache, perhaps with a very short timeout and/or a small data size limit. But you still want to store the data in Redis for backup, and for the requests that aren't as common as the ones you want to store in memory. This is something node-cache-manager handles easily and transparently.

See examples below and in the examples directory. See examples/redis_example for an example of how to implement a Redis cache store with connection pooling.

var cacheManager = require('cache-manager');
var memoryCache = cacheManager.caching({store: 'memory', max: 100, ttl: 10/*seconds*/});
var ttl = 5;
// Note: callback is optional in set() and del(). 
 
memoryCache.set('foo', 'bar', {ttl: ttl}, function(err) {
    if (err) { throw err; }
 
    memoryCache.get('foo', function(errresult) {
        console.log(result);
        // >> 'bar' 
        memoryCache.del('foo', function(err) {});
    });
});
 
function getUser(idcb) {
    setTimeout(function () {
        console.log("Returning user from slow database.");
        cb(null, {id: id, name: 'Bob'});
    }, 100);
}
 
var userId = 123;
var key = 'user_' + userId;
 
// Note: ttl is optional in wrap() 
memoryCache.wrap(key, function (cb) {
    getUser(userId, cb);
}, {ttl: ttl}, function (erruser) {
    console.log(user);
 
    // Second time fetches user from memoryCache 
    memoryCache.wrap(key, function (cb) {
        getUser(userId, cb);
    }, function (erruser) {
        console.log(user);
    });
});
 
// Outputs: 
// Returning user from slow database. 
// { id: 123, name: 'Bob' } 
// { id: 123, name: 'Bob' } 

Here's a very basic example of how you could use this in an Express app:

function respond(reserrdata) {
    if (err) {
        res.json(500, err);
    } else {
        res.json(200, data);
    }
}
 
app.get('/foo/bar', function(reqres) {
    var cacheKey = 'foo-bar:' + JSON.stringify(req.query);
    var ttl = 10;
    memoryCache.wrap(cacheKey, function(cacheCallback) {
        DB.find(req.query, cacheCallback);
    }, {ttl: ttl}, function(errresult) {
        respond(res, err, result);
    });
});

You can use your own custom store by creating one with the same API as the build-in memory stores (such as a redis or memcached store). To use your own store, you can either pass in an instance of it, or pass in the path to the module.

E.g.,

var myStore = require('your-homemade-store');
var cache = cacheManager.caching({store: myStore});
var multiCache = cacheManager.multiCaching([memoryCache, someOtherCache]);
userId2 = 456;
key2 = 'user_' + userId;
ttl = 5;
 
// Sets in all caches. 
multiCache.set('foo2', 'bar2', {ttl: ttl}, function(err) {
    if (err) { throw err; }
 
    // Fetches from highest priority cache that has the key. 
    multiCache.get('foo2', function(errresult) {
        console.log(result);
        // >> 'bar2' 
 
        // Delete from all caches 
        multiCache.del('foo2');
    });
});
 
// Note: options with ttl are optional in wrap() 
multiCache.wrap(key2, function (cb) {
    getUser(userId2, cb);
}, {ttl: ttl}, function (erruser) {
    console.log(user);
 
    // Second time fetches user from memoryCache, since it's highest priority. 
    // If the data expires in the memory cache, the next fetch would pull it from 
    // the 'someOtherCache', and set the data in memory again. 
    multiCache.wrap(key2, function (cb) {
        getUser(userId2, cb);
    }, function (erruser) {
        console.log(user);
    });
});

Both the caching and multicaching modules allow you to pass in a callback function named isCacheableValue which is called with every value returned from cache or from a wrapped function. This lets you specify which values should and should not be cached. If the function returns true, it will be stored in cache. By default the caches cache everything except undefined.

For example, if you don't want to cache false and null, you can pass in a function like this:

 
var isCacheableValue = function(value) {
    return value !== null && value !== false && value !== undefined;
};
 

Then pass it to caching like this:

 
var memoryCache = cacheManager.caching({store: 'memory', isCacheableValue: isCacheableValue};
 

And pass it to multicaching like this:

 
var multiCache = cacheManager.multiCaching([memoryCache, someOtherCache], {
    isCacheableValue: isCacheableValue
});
 

To generate JSDOC 3 documentation:

make docs

To run tests, first run:

npm install -d

Run the tests and JShint:

make

If you would like to contribute to the project, please fork it and send us a pull request. Please add tests for any new features or bug fixes. Also run make before submitting the pull request.

node-cache-manager is licensed under the MIT license.