cacheman-redis

Redis standalone caching library for Node.JS and also cache engine for cacheman.

Instalation

$ npm install cacheman-redis

Usage

var CachemanRedis = require('cacheman-redis');
var cache = new CachemanRedis();

// set the value
cache.set('my key', { foo: 'bar' }, function (error) {

  if (error) throw error;

  // get the value
  cache.get('my key', function (error, value) {

    if (error) throw error;

    console.log(value); //-> {foo:"bar"}

    // delete entry
    cache.del('my key', function (error){

      if (error) throw error;

      console.log('value deleted');
    });

  });
});

API

CachemanRedis([options])

Create cacheman-redis instance. options are redis valid options including port and host.

var options = {
  port: 9999,
  host: '127.0.0.1',
  password: 'my-p@ssw0rd'
  database: 1
};

var cache = new CachemanRedis(options);

You can also pass a redis connection string as first arguments like this:

var cache = new CachemanRedis('redis://127.0.0.1:6379');

Or pass a redis client instance directly as client:

var client = redis.createClient();

var cache = new CachemanRedis(client);

// or
cache = new CachemanRedis({ client: client });

cache.set(key, value, [ttl, [fn]])

Stores or updates a value.

cache.set('foo', { a: 'bar' }, function (err, value) {
  if (err) throw err;
  console.log(value); //-> {a:'bar'}
});

Or add a TTL(Time To Live) in seconds like this:

// key will expire in 60 seconds
cache.set('foo', { a: 'bar' }, 60, function (err, value) {
  if (err) throw err;
  console.log(value); //-> {a:'bar'}
});

cache.get(key, fn)

Retrieves a value for a given key, if there is no value for the given key a null value will be returned.

cache.get(function (err, value) {
  if (err) throw err;
  console.log(value);
});

cache.del(key, [fn])

Deletes a key out of the cache.

cache.del('foo', function (err) {
  if (err) throw err;
  // foo was deleted
});

cache.clear([fn])

Clear the cache entirely, throwing away all values.

cache.clear(function (err) {
  if (err) throw err;
  // cache is now clear
});

cache.scan(cursor, count, [fn])

Scan cache from a cursor point and return a count of values

cache.set('foo', { a: 'bar' }, 10, function (err) {
  cache.scan(0, 10, function (err, result) {
    console.log(result) // { cursor: 0, entries: [{ key: 'foo', data: { a: 'bar' } }] }
  });
});

Run tests

$ make test

License

(The MIT License)

Copyright (c) 2014 Jonathan Brumley <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.