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

Constructors

constructor

Properties

closing keys name opts toKey

Accessors

client redisVersion

Methods

close disconnect emit off on once run waitUntilReady

Constructors

constructor

Properties

closing

closing: Promise<void>

keys

keys: KeysMap

Readonly name

name: string

opts

opts: QueueBaseOptions

toKey

toKey: ((type) => string)

Type declaration

    • (type): string

    • Parameters

      • type: string

      Returns string

Accessors

client

  • get client(): Promise<RedisClient>

  • Returns Promise<RedisClient>

redisVersion

  • get redisVersion(): string

  • Returns string

Methods

close

  • Returns Promise<void>

disconnect

  • Returns Promise<void>

emit

off

on

once

run

  • Returns Promise<void>

waitUntilReady

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc