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

QueueBase
- QueueEvents

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new QueueEvents(name: string, __namedParameters?: QueueEventsOptions, Connection?: typeof RedisConnection): QueueEvents

Overrides QueueBase.constructor
- Defined in classes/queue-events.ts:163
Parameters
- name: string
- __namedParameters: QueueEventsOptions = {}
- Optional Connection: typeof RedisConnection
Returns QueueEvents

Properties

closing

closing: Promise<void>

keys

Readonly name

name: string

opts

opts: QueueBaseOptions = {}

toKey

toKey: (type: string) => string

Type declaration

- (type: string): string
- Parameters
  - type: string
  Returns string

Accessors

client

get client(): Promise<RedisClient>

Inherited from QueueBase.client
- Defined in classes/queue-base.ts:76
Returns a promise that resolves to a redis client. Normally used only by subclasses.

Returns Promise<RedisClient>

redisVersion

get redisVersion(): string

Inherited from QueueBase.redisVersion
- Defined in classes/queue-base.ts:83
Returns the version of the Redis instance the client is connected to,

Returns string

Methods

close

close(): Promise<void>

Overrides QueueBase.close
- Defined in classes/queue-events.ts:300
Stops consuming events and close the underlying Redis connection if necessary.

Returns Promise<void>

disconnect

disconnect(): Promise<void>

Inherited from QueueBase.disconnect
- Defined in classes/queue-base.ts:142
Force disconnects a connection.

Returns Promise<void>

emit

emit<U>(event: U, ...args: Parameters<QueueEventsListener[U]>): boolean

Overrides QueueBase.emit
- Defined in classes/queue-events.ts:192
Emits an event. Normally used by subclasses to emit events.

Type parameters
- U: keyof QueueEventsListener
Parameters
- event: U
- Rest ...args: Parameters<QueueEventsListener[U]>
Returns boolean

off

off<U>(eventName: U, listener: QueueEventsListener[U]): QueueEvents

Overrides QueueBase.off
- Defined in classes/queue-events.ts:199
Type parameters
- U: keyof QueueEventsListener
Parameters
- eventName: U
- listener: QueueEventsListener[U]
Returns QueueEvents

on

on<U>(event: U, listener: QueueEventsListener[U]): QueueEvents

Overrides QueueBase.on
- Defined in classes/queue-events.ts:207
Type parameters
- U: keyof QueueEventsListener
Parameters
- event: U
- listener: QueueEventsListener[U]
Returns QueueEvents

once

once<U>(event: U, listener: QueueEventsListener[U]): QueueEvents

Overrides QueueBase.once
- Defined in classes/queue-events.ts:215
Type parameters
- U: keyof QueueEventsListener
Parameters
- event: U
- listener: QueueEventsListener[U]
Returns QueueEvents

run

run(): Promise<void>

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

waitUntilReady

waitUntilReady(): Promise<RedisClient>

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

Generated using TypeDoc