1.0.3 • Published 8 years ago
node-redis-pool v1.0.3
node-redis-pool
A node.js connection pool for Redis.
About
node-redis-pool is high-level redis management object. It manages a number of connections in a pool, using them as needed and keeping all aspects of releasing active connections internal to the object, so the user does not need to worry about forgotten connections leaking memory and building up over time.
Installation
npm install node-redis-pool
Usage
var redisPool = require('node-redis-pool')('myRedisPool',{
host: '127.0.0.1', //default
port: 6379, //default
max_clients: 30, //defalut
perform_checks: false, //checks for needed push/pop functionality
options: {
auth_pass: 'password'
} //options for createClient of node-redis, optional
});
redisPool.set('test-key', 'foobar', function (err) {
redisPool.get('test-key', function (err, reply) {
console.log(reply); // 'foobar'
});
});
Implemented methods
- get
get(key, cb)
- incr
incr(key, cb)
- set
set(key, value, expx, ttl, nxxx, cb)
- expire
expire(key, seconds, cb)
- hget
hget(key, field, cb)
- hgetall
hgetall(key, cb)
- hset
hset(key, field, value, cb)
- brpop
brpop(key, cb)
- blpop
blpop(key, cb)
- rpush
rpush(key, value, cb)
- lpush
lpush(key, value, cb)
API Documentation
node-redis-pool uses NaturalDocs to generate API documentation, which can be viewed after cloning the repository, in the doc/ directory, using a web browser.