Skip to content

Latest commit

 

History

History
136 lines (100 loc) · 4.59 KB

README.md

File metadata and controls

136 lines (100 loc) · 4.59 KB

npm version Build Status Coverage Status Patreon donate button

node-redis-connection-pool See on Github

Simplistic node redis connection pool ready can scale with generic-pool support

Documentation

Prerequisites

  • node >= 8 This module requires nodejs v8 or later
  • redis >= 4 This module requires redis v4 or above as it has dependencies on UNLINK and redis.replicate_commands() for pattern deletion.

Getting started

    npm install node-redis-connection-pool

Usage

  • Seemless execution of commands.
    var RedisPool = require("node-redis-connection-pool");
    var pool = new RedisPool();

    pool.sendCommand("set", ["key", "value"])
  • Want redis raw connection? you got it
    pool.acquire()
      .then(conn => {

        // Do some work

        // At the end release the conn back to the pool
        pool.release(conn)
      });

API

  • RedisPool([options])
options object properties
Name Type Description
name string

Name your pool

redisOptions object

opts from node_redis#options-object-properties

poolOptions object

opts from node-pool#createpool

logger object

Inject your custom logger

Run tests

bash test.sh

Contribute

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.

Backers

Maintainers

These amazing people are maintaining this project:

Sponsors

No sponsors yet! Will you be the first?

Patreon donate button Flattr donate button

Contributors

These amazing people have contributed to/reviewed this project:

Discover how you can contribute by heading on over to the CONTRIBUTING.md file.