RedisQueue class

Class RedisQueue Implements simple messaging queue over redis.

Signature:

export declare class RedisQueue extends EventEmitter implements IMessageQueue

Extends: EventEmitter

Implements: IMessageQueue

Constructors

Constructor	Modifiers	Description
(constructor)(name, options, mode)		Constructs a new instance of the `RedisQueue` class

Property

Modifiers

Type

Description

string

This queue instance options

{IMQOptions}

Method	Modifiers	Description
clear()		Clears queue data in redis;
destroy()		Gracefully destroys this queue
isPublisher()		Returns true if publisher mode is enabled on this queue, false otherwise. {boolean}
isWorker()		Returns true if worker mode is enabled on this queue, false otherwise. {boolean}
publish(data, toName)		Publishes a message to this queue subscription channel for currently subscribed clients. If toName specified will publish to pubsub with different name. This can be used to implement broadcasting some messages to other subscribers on other pubsub channels.
send(toQueue, message, delay, errorHandler)		Sends given message to a given queue (by name)
start()		Initializes and starts current queue routines
stop()		Stops current queue routines
subscribe(channel, handler)		Creates subscription channel over redis and sets up channel data read handler
unsubscribe()		Closes subscription channel {Promise}