rcc-ioredis-adapter v1.0.10

Wraps and adapts the 'ioredis' module and its Redis client instances to be used with the 'redis-client-cache' module

Main module:

• rcc-ioredis-adapter.js

This module is exported as a Node.js module.

Installation

Using npm:

$ npm i --save rcc-ioredis-adapter

Usage

• To use the rcc-ioredis-adapter module

// Get the ioredis adapter
const redis = require('rcc-ioredis-adapter');
assert(redis);

// Create a redis client using the redis adapter
const redisClientOptions = {host: '127.0.0.1', port: 6379, string_number: true};
const redisClient = redis.createClient(redisClientOptions);
assert(redisClient);

// Get the host & port of the redis client
const [host, port] = redisClient.resolveHostAndPort();
assert(host === '127.0.0.1');
assert(port === 6379);

// Check if the redis client is closing or not
const closing = redisClient.isClosing();
assert(!closing);

// Set and get a value for a key using the underlying `ioredis` module's `Redis` client instance's methods
redisClient.set('KEY', 'VALUE', (err, res) => {
  if (!err) {
    console.log(res);
    redisClient.get('KEY', (err, value) => {
      if (!err) {
        assert(value === 'VALUE');
      }
    });
  }
})

Unit tests

This module's unit tests were developed with and must be run with tape. The unit tests have been tested on Node.js v6.10.3.

See the package source for more details.

Changes

See CHANGES.md