redis-connection-pool

redis-connection-pool

A node.js connection pool for Redis.

About

node-redis-connection-pool is a 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 resources.

Installation

npm install redis-connection-pool

Usage

import redisPoolFactory from 'redis-connection-pool';
const redisPool = await redisPoolFactory('myRedisPool', {
    max_clients: 5, // default
    redis: {
      url: 'redis://localhost:6379'
    }
  });


await redisPool.set('test-key', 'foobar');
const foo = await redisPool.get('test-key');
// returns 'foobar'

Or you can create a pool instance directly

import RedisConnectionPool from 'redis-connection-pool';
const redisPool = new RedisConnectionPool();
await redisPool.init();

Implemented methods

• get

get(key)

• set

set(key, value, ttl)

• expire

expire(key, value)

• del

del(key)

• hget

hget(key, field)

• hgetall

hgetall(key)

• hset

hset(key, field, value)

• hdel

hdel(key, [fields])

• brpop

brpop(key)

• brpoplpush

brpoplpush(key1, key2)

• blpop

blpop(key)

• rpush

rpush(key, value)

• lpush

lpush(key, value)

• sendCommand

sendCommand(commandName, [args])

• shutdown

shutdown()

API Documentation

node-redis-connection-pool uses jsdoc-to-markdown to generate the API.md from the source code.

License

MIT