Package detail

make-redis-client

benkroeger6MITdeprecated0.0.6

This module is no longer maintained

Provides a simple factory function that returns a redis client instance

make-redis-client, redis, factory, redis-client

readme

Provides a simple factory function that returns a redis client instance

Install

$ npm install --save make-redis-client

Usage

Call the exported function with a plain object containing the properties you want your redis client to be configured with. It returns a redisClient.

In addition to the config options from redis, you can also define the database you want to select in redis.

Valid Options


var validRedisOptions = [
    'unixSocket', // if this is presented, host and port are ignored
    'host',
    'port',
    'parser',
    'return_buffers',
    'detect_buffers',
    'socket_nodelay',
    'socket_keepalive',
    'no_ready_check',
    'enable_offline_queue',
    'retry_max_delay',
    'connect_timeout',
    'max_attempts',
    'auth_pass',
    'family',
    'db'
];

Example

var makeRedisClient = require('make-redis-client');

var client = makeRedisClient({
    host: '127.0.0.1',
    port: 6379,
    db: 5,
    connect_timeout: 300
});

client.get('foo', function(err, result) {
    console.log(result);
});