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

This class requires a dedicated redis connection.




closing: Promise<void>
keys: KeysMap
name: string
opts: QueueBaseOptions
toKey: ((type) => string)

Type declaration

    • (type): string
    • Parameters

      • type: string

      Returns string


  • get client(): Promise<RedisClient>
  • Returns a promise that resolves to a redis client. Normally used only by subclasses.

    Returns Promise<RedisClient>

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

    Returns string


  • Stops consuming events and close the underlying Redis connection if necessary.

    Returns Promise<void>

  • Force disconnects a connection.

    Returns Promise<void>

  • 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