Camaro Redis

中文文档说明

Redis client for node, support resp2/3, redis6, and all commands of redis.

Features

The first redis client to support resp3 .

• All commands of redis support.
• All command results return promise.
• Support for ES6 types, such as Map and Set.
• Support for TLS.

Quick Start

Install

npm install @camaro/redis

Usage

// If you want to use resp2 ,change `ClientV3` to `ClientV2`.
const { ClientV3: Client } = require('@camaro/redis')
const client = new Client();

client.SET('foo', 'foo').then(() => {
    return client.GET('foo')
}).then(reply => {
    console.log(reply) // 'foo'
})

// Or if you want to use async/await.
await client.SET('bar', 'bar')
const reply = await client.GET('bar')
console.log(reply) // 'bar'

Client Options

API Reference

Client.Constructor

The Client class has a constructor that can pass Options.

Commands

All redis command can be used like this:

const client = new Client();
client.SET(...args);
client.GET(...args);
// ... other commands

See the complete command list: https://redis.io/commands .

Events

• message: See Pub/Sub
• error: Emitted when a error occurs.
• connect: Emitted when the client is established. Commands issued before the connect event are queued, then replayed just before this event is emitted.

Pub/Sub

You can receive pub/sub message by message event and handle it in the callback function.

If you are using the resp2, you need to create a new client to receive messages.

const client = new Client();
client.SUBSCRIBE('test');
client.on('message', (data)=>{
    // data: ['message','somechannel','this is the message']
    console.log(data);    
})