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, Expand)

QueueBase
- QueueEvents

Index

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:278

Properties

closing

closing: Promise<void>

keys

keys: KeysMap

`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:87

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:98

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:420

disconnect

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

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

emit

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

off

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

on

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

once

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

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:344

trace

trace<T>(
    spanKind: SpanKind,
    operation: string,
    destination: string,
    callback: (span?: Span, dstPropagationMetadata?: string) => T | Promise<T>,
    srcPropagationMetadata?: string,
): Promise<T | Promise<T>>
Wraps the code with telemetry and provides a span for configuration.
Type Parameters
- T
Parameters
- spanKind: SpanKind
  kind of the span: Producer, Consumer, Internal
- operation: string
  operation name (such as add, process, etc)
- destination: string
  destination name (normally the queue name)
- callback: (span?: Span, dstPropagationMetadata?: string) => T | Promise<T>
  code to wrap with telemetry
- OptionalsrcPropagationMetadata: string
Returns Promise<T | Promise<T>>
Inherited from QueueBase.trace
- Defined in classes/queue-base.ts:192

waitUntilReady

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

Class QueueEvents

Hierarchy (View Summary, Expand)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns QueueEvents

Properties

closing

keys

Readonlyname

opts

ReadonlyqualifiedName

toKey

Accessors

client

Returns Promise<RedisClient>

redisVersion

Returns string

Methods

close

Returns Promise<void>

disconnect

Returns Promise<void>

emit

Type Parameters

Parameters

Returns boolean

off

Type Parameters

Parameters

Returns this

on

Type Parameters

Parameters

Returns this

once

Type Parameters

Parameters

Returns this

run

Returns Promise<void>

trace

Type Parameters

Parameters

Returns Promise<T | Promise<T>>

waitUntilReady

Returns Promise<RedisClient>

Settings

On This Page

`Readonly`name

`Readonly`qualifiedName