Class Consumer

This client is based in the functionality of kafkajs for NodeJS. In the moment of implement the port, this library show some issues and not clear API about how the connection handshake and events are managed by the library, for this reason we decide to include an admin client in all the cases, even when we only want to stablish a consumer or producer.

Hierarchy (View Summary)

Constructors

constructor

Properties

consumerOptions options

Accessors

client state

Methods

on start stop

Constructors

constructor

  • new Consumer(
        clientOptions: KafkaConfig,
        consumerOptions: ConsumerConfig,
        interval?: number,
    ): Consumer

  • Creates an instance of KafkaConsumer

    Parameters

    • clientOptions: KafkaConfig

      Kafka client configuration options

    • consumerOptions: ConsumerConfig

      Kafka consumer configuration options

    • Optionalinterval: number

      Period of health check interval

    Returns Consumer

Properties

ReadonlyconsumerOptions

consumerOptions: ConsumerConfig

Kafka Consumer configuration options

Readonlyoptions

options: KafkaConfig

Kafka Broker configuration options

Accessors

client

  • get client(): Consumer

  • Kafka consumer

    Returns Consumer

state

  • get state(): boolean

  • Overall client state

    Returns boolean

Methods

on

  • on(event: "healthy", listener: () => void): this

  • Emitted when admin client can collect the desired information

    Parameters

    • event: "healthy"
    • listener: () => void

    Returns this

  • on(event: "unhealthy", listener: (crash: Crash) => void): this

  • Emitted when admin client can not collect the desired information

    Parameters

    • event: "unhealthy"
    • listener: (crash: Crash) => void

    Returns this

  • on(event: "status", listener: (status?: SystemStatus) => void): this

  • Emitted every time that admin client get metadata from brokers

    Parameters

    Returns this

  • on(event: "error", listener: (crash: Crash) => void): this

  • Emitted when admin client has some problem getting the metadata from brokers

    Parameters

    • event: "error"
    • listener: (crash: Crash) => void

    Returns this

start

  • start(): Promise<void>

  • Perform the connection of the instance to the system

    Returns Promise<void>

stop

  • stop(): Promise<void>

  • Perform the disconnection of the instance from the system

    Returns Promise<void>

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods