Class KafkaJSConsumerConnector

Description

KafkaJS consumer connector

Features:

  • consumer connector manager for KafkaJS

Example

Hierarchy

Constructors

constructor

Properties

#connections #current #private config configs counter histogram namespace

Accessors

connections current

Methods

catch connect connection create get initialize subscribe unsubscribe use

Constructors

constructor

Properties

Private #connections

#connections: Map<string, Consumer>

Description

Private connections storage

Private #current

#current: Consumer

Description

Private link to selected (used) connection

Private #private

#private: any

Protected config

config: IConfig

Protected Readonly configs

configs: Map<string, IKafkaJSConsumerConfig> = ...

Description

configs

Protected counter

counter: Counter<string>

Description

Counter

Protected histogram

histogram: Histogram<string>

Description

Histogram

Protected Readonly namespace

namespace: "KafkaJSConsumer" = 'KafkaJSConsumer'

Description

Namespace path for fetching configuration

Accessors

connections

  • get connections(): Map<string, T>

  • Returns Map<string, T>

current

  • get current(): T

  • Returns T

Methods

Protected catch

Protected connect

connection

  • connection(name?): Consumer

  • Parameters

    • Optional name: string

    Returns Consumer

create

  • create(config): Promise<Consumer>

  • Parameters

    Returns Promise<Consumer>

get

  • get(name?): Consumer

  • Parameters

    • Optional name: string

    Returns Consumer

Protected initialize

  • initialize(): Promise<void>

  • Returns Promise<void>

subscribe

  • subscribe(name, handler): Promise<void>

  • Parameters

    • name: string
    • handler: ((messages, batch) => Promise<void>)
        • (messages, batch): Promise<void>

        • Parameters

          • messages: KafkaMessage[]
          • batch: Omit<Batch, "messages">

          Returns Promise<void>

    Returns Promise<void>

    Description

    Subscribe

unsubscribe

use

  • use(name): void

  • Parameters

    • name: string

    Returns void

Settings

Member Visibility

Theme

On This Page

constructor#connections#current#privateconfigconfigscounterhistogramnamespaceconnectionscurrentcatchconnectconnectioncreategetinitializesubscribeunsubscribeuse