redcached

Node RedCached

---

Installation

First install node.js and redis. Then:

$ npm install redcached

Usage

var RedCached = require('redcached');

var redCached = new RedCached();

Optinal redis options

var redCached = new RedCached({ //https://github.com/mranney/node_redis#rediscreateclient
    host: 'localhost',
    port: 6379
});

Get example

Simple get example

redCached.get('https://api.github.com/users/pmdroid', function(err, data){
    console.log(data);
});

Multiple request at one time, will return all request at one time

redCached.get([
    'https://api.github.com/users/pmdroid',
    'https://api.github.com/users/pmdroid'
], function(err, data){
    console.log(data);
});

Optional options

redCached.get('https://api.github.com/users/pmdroid', {
    key: function(key){ //optinal change the key
        return crypto.createHash('md5').update(key).digest("hex");
    },
    ttl: 3600, //set ttl to 1 Hour
    request: { //https://github.com/mikeal/request#requestoptions-callback
        headers: {
            'User-Agent': 'NodeJS'
        }
    }
}, function(err, data){
    console.log(data);
});

Delete data by url

redCached.del('https://api.github.com/users/pmdroid', function(err, data){
    console.log(data);
});

License

Copyright (c) 2014 Pascal Matthiesen <[e-mail]>

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.