Class RedisQueue

constructor

• new RedisQueue(
      name: string,
      options?: Partial<IMQOptions>,
      mode?: IMQMode,
  ): RedisQueue

  Parameters

  • name: string
  • Optionaloptions: Partial<IMQOptions>
  • Optionalmode: IMQMode = IMQMode.BOTH

  Returns RedisQueue

name

options

clear

• clear(): Promise<RedisQueue>

  Clears queue data in redis;

  Returns Promise<RedisQueue>

destroy

• destroy(): Promise<void>

  Gracefully destroys this queue

  Returns Promise<void>

isPublisher

• isPublisher(): boolean

  Returns true if publisher mode is enabled on this queue, false otherwise.

  Returns boolean

isWorker

• isWorker(): boolean

  Returns true if worker mode is enabled on this queue, false otherwise.

  Returns boolean

publish

• publish(data: JsonObject, toName?: string): Promise<void>

  Publishes a message to this queue subscription channel for currently subscribed clients.

  If toName specified will publish to PubSub with a different name. This can be used to implement broadcasting some messages to other subscribers on other PubSub channels.

  Parameters

  • data: JsonObject
  • OptionaltoName: string

  Returns Promise<void>

send

• send(
      toQueue: string,
      message: JsonObject,
      delay?: number,
      errorHandler?: (err: Error) => void,
  ): Promise<string>

  Sends a given message to a given queue (by name)

  Parameters

  • toQueue: string
  • message: JsonObject
  • Optionaldelay: number
  • OptionalerrorHandler: (err: Error) => void

  Returns Promise<string>

start

• start(): Promise<RedisQueue>

  Initializes and starts current queue routines

  Returns Promise<RedisQueue>

stop

• stop(): Promise<RedisQueue>

  Stops current queue routines

  Returns Promise<RedisQueue>

subscribe

• subscribe(channel: string, handler: (data: JsonObject) => any): Promise<void>

  Creates a subscription channel over redis and sets up channel data read handler

  Parameters

  • channel: string
  • handler: (data: JsonObject) => any

  Returns Promise<void>

unsubscribe

• unsubscribe(): Promise<void>

  Closes subscription channel

  Returns Promise<void>