redis-cluster-queue v1.0.1

Redis Cluster Queue

Simple queue on Redis Cluster and single redis instance. This plugin also supports AWS ElastiCache as well. Auto discover redis is enable cluster mode or not and recreate connection again.

License

This plugin is licensed under the MIT license and can ve viewed in the LICENSE file.

Installation

Install using npm

npm install redis-cluster-queue --save

Tests

IMPORTANT: You need to have Redis running to run tests

npm test

Typescript

import { RedisClusterQueue } from 'redis-cluster-queue';

const redisClusterQueue = new RedisClusterQueue({
  host: 'localhost',
  port: 6379
});

const queueName = 'queue_' + new Date().getTime();

await redisClusterQueue.createQueue({
  name: queueName,
});

const messageId = await redisClusterQueue.sendMessage({
  queueName: queueName,
  message: 'hihi'
});

await redisClusterQueue.changeMessageVisibility({
  queueName: queueName,
  messageId,
  visibilityTimeout: 40,
});

const attributes = await redisClusterQueue.getQueueAttributes({
  name: queueName,
});

const message = await redisClusterQueue.receiveMessage({
  queueName: queueName,
});

const deleted = await redisClusterQueue.deleteMessage({
  queueName: queueName,
  messageId: message.id,
});

const queueAttributes = await redisClusterQueue.setQueueAttributes({
  name: queueName,
  visibilityTimeout: 30,
  maxsize: 2000,
  delay: 0,
});

const message2 = await redisClusterQueue.popMessage({
  queueName: queueName,
});

const queues = await redisClusterQueue.listQueues();

const queueDeleted = await redisClusterQueue.deleteQueue({
  name: queueName,
});
// in case you want to disconnect
await redisClusterQueue.quit();

Methods

Constructor

Create a new instance of RedisClusterQueue

Parameters:

listQueues()

Get list queue's name

Return array: ######['queue_1']

createQueue(options)

Create queue

Params of options:

Return: ######1 if queue created

deleteQueue(options)

Delete queue

Params of options:

Return: ######1 if queue deleted

getQueueAttributes(options)

Get queue's attributes

Params of options:

Return Object:

setQueueAttributes(options)

Get queue's attributes

Params of options(Requires at least one in three params visibilityTimeout, delay, maxsize):

Return Object:

sendMessage(options)

Send a message to the queue

Params of options:

Return message's id:

######g1mia8gfux-b336fd53-d4ea-4b1e-8fad-c6217e313133

popMessage(options)

Get and delete one message immediately from queue

Params of options:

Return Object:

receiveMessage(options)

Get message from queue

Params of options:

Return Object:

deleteMessage(options)

Delete the message from queue

Params of options:

Return: ######1 if message deleted

changeMessageVisibility(options)

Change visibility timeout of specific message

Params of options:

Return: ######1 if ok

quit()

Disconnect redis