redis-clients

redis client factories for nodejs

Requirements

• Redis 2.8.0+
• NodeJS 8.1.4+

Installation

$ npm install --save redis-clients

Usage

//initialize redis-clients with default options
const redis = require('redis-clients')([options]);

//obtain normal redis client
const client = redis.client();

//set data
client.set('abc:1', 1);
client.set('abc:2', 2);
client.set('abc:3', 3);

//count keys based on pattern
redis.count('abc:*', function(error, count){
    ...
});

//count keys based on pattern
redis.count('abc:*', 'x:*', function(error, counts){
    ...
});

//obtain pub/sub clients
const { publisher, subscriber } = redis.pubsub();

//clear users data
redis.clear('users*', function(error, response){
    ...
});

//clear all data
redis.clear(function(error, response){
    ...
});

//reset and quit all clients
redis.quit();

Options

• prefix:String - redis key prefix. default to r
• separator:String - redis key separator. default to :
• redis:Object|String - redis connections options or connection string.

To initialize redis with custom options use

const redis = require('redis-clients')({
    prefix:'q',
    separator:'-',
    redis: {
    port: 6379,
    host: '127.0.0.1'
  }
});

...

or 

const redis = require('redis-clients')({
    prefix:'q',
    separator:'-',
    redis: 'redis://localhost:6379'
});

API

createClient([options:Object]):Object

Create a new instance of redis client

const redis = require('redis-clients')();
const client = redis.createClient([options]);

...

pubsub():{publisher:Object, subscriber:Object}

Obtain existing or create new instances of publisher and subscriber redis clients

const redis = require('redis-clients')();
const { publisher, subscriber } = redis.pubsub();

...

client():Object

Obtain existing or create new instance of redis client

const redis = require('redis-clients')();
const client = redis.client();

...

multi():Object

Create new instance of redis multi command object

const redis = require('redis-clients')();
const client = redis.multi();

...

info(done:Function):Object

Obtain informations of the current redis server.

const redis = require('redis-clients')();
redis.info(function(error, info){
    ...
});

key(...args):String

Build redis storage key using prefix and separator options

const redis = require('redis-clients')();

//generate random key
const key = redis.key();
expect(key).to.exist;
expect(key.split(':')).to.have.length(2);

const key = redis.key('ab');
expect(key).to.be.equal('r:ab');

const key = redis.key(['users', 'ab']);
expect(key).to.be.equal('r:users:ab');

const key = redis.key('users', 'likes', 'vegetables');
expect(key).to.be.equal('r:users:likes:vegetables');

...

clear(pattern:String,[done:Function]):Array[String>

clear data using specified pattern. if pattern not provided all data will be deleted

const redis = require('redis-clients')();

//clear all data
redis.clear(function(error, responses){
    ...
});

//clear all key 'users*'
redis.clear('users',function(error, responses){
    ...
});

...

reset()

Reset current state of redis

const redis = require('redis-clients')();
redis.reset();

...

count(pattern:String, done:Function)

Count(or obtain size) of keys based on the specified pattern. If no pattern specified all keys will be counted.

const redis = require('redis-clients')();
redis.count('abc:*', function(error, count){
    ...
});

...

Testing

• Clone this repository

• Install all development dependencies

$ npm install

• Then run test

$ npm test

Contribute

It will be nice, if you open an issue first so that we can know what is going on, then, fork this repo and push in your ideas. Do not forget to add a bit of test(s) of what value you adding.

Licence

The MIT License (MIT)

Copyright (c) 2017 lykmapipo & Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.