Napoleonic Panda Machine

    node-redis-connection-pool
    TypeScript icon, indicating that this package has built-in type declarations

    3.1.0 • Public • Published

    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.

    Install

    npm i node-redis-connection-pool

    DownloadsWeekly Downloads

    313

    Version

    3.1.0

    License

    WTFPL

    Unpacked Size

    69.7 kB

    Total Files

    40

    Last publish

    Collaborators

    • pasupulaphani