Skip to content

Latest commit

 

History

History
83 lines (62 loc) · 1.93 KB

README.md

File metadata and controls

83 lines (62 loc) · 1.93 KB

redis-connection-pool

A node.js connection pool for Redis.

https://silverbucket.github.io/redis-connection-pool

Build Status license downloads

About

A high-level redis connection pooling 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.

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();

When you are done

redisPool.shutdown();

Implemented Redis methods

  • blpop
  • brpop
  • del
  • expire
  • get
  • hdel
  • hget
  • hgetall
  • hset
  • incr
  • keys
  • lpush
  • rpush
  • sendCommand
  • set
  • ttl

Additional methods

  • init
  • shutdown

API Documentation

For the full documentation on the RedisConnectionPool class, see https://silverbucket.github.io/redis-connection-pool/classes/RedisConnectionPool.html

License

MIT