Class QueueEventsProducer

backend

closing

keys

Readonlyname

opts

ReadonlyqualifiedName

toKey

disconnect

• disconnect(): Promise<void>

  Force disconnects a connection.

  Returns Promise<void>

emit

• emit(event: string | symbol, ...args: any[]): boolean

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

  Parameters

  • event: string | symbol

    The emitted event.

  • ...args: any[]

    The arguments to pass to the event listeners.

  Returns boolean

  True if the event had listeners, false otherwise.

getBackend

• getBackend(): IQueueBackend

  Returns the datastore backend that powers this instance.

  The backend owns its connection(s) and exposes every datastore-agnostic operation through IQueueBackend. Datastore-specific escape hatches (e.g. the raw Redis client) live on the concrete backend implementation, and are exposed here when the class is parameterized on that concrete backend type (the default for the built-in, Redis-backed classes).

  Returns IQueueBackend

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

    The source propagation metadata for telemetry context.

  Returns Promise<T | Promise<T>>

  The result of the callback function.

waitUntilReady

• waitUntilReady(): Promise<void>

  Resolves once the underlying backend (and its connection) is ready.

  Returns Promise<void>