Class QueueEventsProducer

closing

keys

Readonly name

opts

Readonly qualifiedName

toKey

client

• get client(): Promise<RedisClient>

• Returns a promise that resolves to a redis client. Normally used only by subclasses.

  Returns Promise<RedisClient>

redisVersion

• get redisVersion(): string

• Returns the version of the Redis instance the client is connected to,

  Returns string

disconnect

• disconnect(): Promise<void>

• Force disconnects a connection.

  Returns Promise<void>

emit

• emit(event, ...args): boolean

• Emits an event. Normally used by subclasses to emit events.

  Parameters

  • event: string | symbol

    The emitted event.
  • Rest ...args: any[]

  Returns boolean

trace

• trace<T>(spanKind, operation, destination, callback, srcPropagationMetadata?): 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?, dstPropagationMetadata?) => T | Promise<T>)

    code to wrap with telemetry

    • • (span?, dstPropagationMetadata?): T | Promise<T>

      • Parameters

        • Optional span: Span<any>
        • Optional dstPropagationMetadata: string

        Returns T | Promise<T>

  • Optional srcPropagationMetadata: string

  Returns Promise<T | Promise<T>>

waitUntilReady

• waitUntilReady(): Promise<RedisClient>

• Returns Promise<RedisClient>