Options
All
  • Public
  • Public/Protected
  • All
Menu

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

Index

Constructors

Properties

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

Type declaration

    • (type: string): string
    • Parameters

      • type: string

      Returns string

Accessors

  • 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

Methods

  • close(): Promise<void>
  • disconnect(): Promise<void>
  • run(): 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