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 Summary)

QueueBase
- QueueEvents

Index

Constructors

Properties

closing keys name opts qualifiedName toKey

Accessors

client redisVersion

Methods

close disconnect emit off on once run waitUntilReady

Constructors

constructor

new QueueEvents(
    name: string,
    __namedParameters?: QueueEventsOptions,
    Connection?: typeof RedisConnection,
): QueueEvents
Parameters
- name: string
- __namedParameters: QueueEventsOptions = {}
- OptionalConnection: typeof RedisConnection
Returns QueueEvents
Overrides QueueBase.constructor
- Defined in classes/queue-events.ts:167

Properties

closing

closing: Promise<void>

keys

`Readonly`name

name: string

The name of the queue.

opts

opts: QueueBaseOptions = {}

Options for the queue.

`Readonly`qualifiedName

qualifiedName: string

toKey

toKey: (type: string) => string

Accessors

client

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

Returns Promise<RedisClient>
Inherited from QueueBase.client
- Defined in classes/queue-base.ts:90

redisVersion

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

Returns string
Inherited from QueueBase.redisVersion
- Defined in classes/queue-base.ts:97

Methods

close

close(): Promise<void>
Stops consuming events and close the underlying Redis connection if necessary.

Returns Promise<void>
Overrides QueueBase.close
- Defined in classes/queue-events.ts:304

disconnect

disconnect(): Promise<void>
Force disconnects a connection.

Returns Promise<void>
Inherited from QueueBase.disconnect
- Defined in classes/queue-base.ts:158

emit

emit<U extends keyof QueueEventsListener>(
event: U,
...args: Parameters<QueueEventsListener[U]>,
): boolean
Emits an event. Normally used by subclasses to emit events.
Type Parameters
- U extends keyof QueueEventsListener
Parameters
- event: U
  The emitted event.
- ...args: Parameters<QueueEventsListener[U]>
Returns boolean
Overrides QueueBase.emit
- Defined in classes/queue-events.ts:196

off

off<U extends keyof QueueEventsListener>(
eventName: U,
listener: QueueEventsListener[U],
): this
Type Parameters
- U extends keyof QueueEventsListener
Parameters
- eventName: U
- listener: QueueEventsListener[U]
Returns this
Overrides QueueBase.off
- Defined in classes/queue-events.ts:203

on

on<U extends keyof QueueEventsListener>(
event: U,
listener: QueueEventsListener[U],
): this
Type Parameters
- U extends keyof QueueEventsListener
Parameters
- event: U
- listener: QueueEventsListener[U]
Returns this
Overrides QueueBase.on
- Defined in classes/queue-events.ts:211

once

once<U extends keyof QueueEventsListener>(
event: U,
listener: QueueEventsListener[U],
): this
Type Parameters
- U extends keyof QueueEventsListener
Parameters
- event: U
- listener: QueueEventsListener[U]
Returns this
Overrides QueueBase.once
- Defined in classes/queue-events.ts:219

run

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>
- Defined in classes/queue-events.ts:231

waitUntilReady

waitUntilReady(): Promise<RedisClient>
Returns Promise<RedisClient>
Inherited from QueueBase.waitUntilReady
- Defined in classes/queue-base.ts:129