Class QueueEvents

The QueueEvents class is used for listening to the global events emitted by a given queue.

This class requires a dedicated redis connection.

Hierarchy (view full)



closing: Promise<void>
keys: KeysMap
name: string

The name of the queue.

opts: QueueBaseOptions = ...

Options for the queue.

qualifiedName: string
toKey: ((type) => string)

Type declaration

    • (type): string
    • Parameters

      • type: string

      Returns string


  • get redisVersion(): string
  • Returns the version of the Redis instance the client is connected to,

    Returns string


  • Manually starts running the event consumming loop. This shall be used if you do not use the default "autorun" option on the constructor.

    Returns Promise<void>

Generated using TypeDoc