Class QueueEventsProducer

The QueueEventsProducer class is used for publishing custom events.

Hierarchy (view full)

Constructors

Properties

closing: Promise<void>
keys: KeysMap
name: string

The name of the queue.

opts: QueueBaseOptions = ...

Options for the queue.

qualifiedName: string
toKey: ((type) => string)

Type declaration

    • (type): string
    • Parameters

      • type: string

      Returns string

Accessors

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

    Returns string

Methods

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

    Parameters

    • event: string | symbol

      The emitted event.

    • Rest ...args: any[]

    Returns boolean

  • Publish custom event to be processed in QueueEvents.

    Type Parameters

    • T extends {
          eventName: string;
      }

    Parameters

    • argsObj: T

      Event payload

    • maxEvents: number = 1000

      Max quantity of events to be saved

    Returns Promise<void>

  • 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>>

Generated using TypeDoc