CNN Caching

Makes working with caching easier. Now with hash ring support!

Fork of mape/node-caching

!node

Installation

Via npm:

``
$ npm install cnn-caching
`

Built in stores

* Memory
* Redis
* Hash Ring

$3

`javascript
var Caching = require('cnn-caching');
var cache = new Caching('redis'); / use 'memory', 'redis' or 'hashring' /

var ttl = 60 * 1000; // 1minute;
cache('twitter-users', ttl, function(passalong) {
getMostActiveTwitterUser(function(err, userName) {
fetchTwitterFollowers(userName, passalong); // passalong replaces function(err, userList) {}
})
}, function(err, userList) {
console.log(userList);
});
`

$3

`javascript
var Caching = require('cnn-caching');
var cache = new Caching();

setInterval(function() {
cache('key', 10000 /ttl in ms/, function(passalong) {
// This will only run once, all following requests will use cached data.
setTimeout(function() {
passalong(null, 'Cached result');
}, 1000);
}, function(err, results) {
// This callback will be reused each call
console.log(results);
});
}, 100);
`

$3

`javascript
var Caching = require('cnn-caching');
var cache = new Caching('redis');

setInterval(function() {
cache('key', 10000 /ttl in ms/, function(passalong) {
// This will only run once, all following requests will use cached data.
setTimeout(function() {
passalong(null, 'Cached result');
}, 1000);
}, function(err, results) {
// This callback will be reused each call
console.log(results);
});
}, 100);
`

$3

`javascript
var Caching = require('cnn-caching');
var cache = new Caching('hashring', {
"servers": 'http://localhost:6377,http://localhost:6378,http://localhost:6379,http://localhost:6380',
"max cache size": 10000, / Any node-hashing options allowed /
"minTtl": 10 / Minimum TTL that cnn-caching will actually cache (default 0) /
});

setInterval(function() {
cache('key', 10000 /ttl in ms/, function(passalong) {
// This will only run once, all following requests will use cached data.
setTimeout(function() {
passalong(null, 'Cached result');
}, 1000);
}, function(err, results) {
// This callback will be reused each call
console.log(results);
});
}, 100);
`

Api

`
cache(key, ttl, runIfNothingInCache, useReturnedCachedResults);
`

$3

Key, 'myKey'

$3

Time To Live in ms, 60301000

$3

Callback that will run if results aren't already in cache store.

`javascript
function (passalong) {
setTimeout(function() {
passalong(null, 'mape', 'frontend developer', 'sweden');
}, 1000);
}
`

$3

Callback that is called every time the method runs.

`javascript
function(err, result) {
console.log(name, result);
}
``