Class KafkaJSConsumerConnector

Description

KafkaJS consumer connector

Features:

consumer connector manager for KafkaJS

Example

Hierarchy

Connector<IKafkaJSConsumerConfig, IKafkaJSConsumerConnection>
- KafkaJSConsumerConnector

Index

Constructors

constructor

new KafkaJSConsumerConnector(): KafkaJSConsumerConnector
Returns KafkaJSConsumerConnector

Inherited from Connector.constructor

Properties

`Private` #connections

#connections: Map<string, Consumer>

Description

Private connections storage

`Private` #connections

#connections: Map<string, Consumer> = ...

Description

Private connections storage

`Private` #current

#current: Consumer

Description

Private link to selected (used) connection

`Private` #current

#current: Consumer = undefined

Description

Private link to selected (used) connection

`Protected` config

config: IConfig

Description

Config dependency

`Protected` `Readonly` configs

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

Description

configs

`Protected` counter

counter: Counter

Description

Counter

`Protected` histogram

histogram: Histogram

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>

Description
Connections storage
Inherited from Connector.connections
- Defined in packages/@biorate/connector/src/index.ts:81

current

get current(): T
Returns T

Description
Link to selected (used) connection
Inherited from Connector.current
- Defined in packages/@biorate/connector/src/index.ts:87

Methods

`Protected` catch

catch(e, messages, batch): Promise<void>
Parameters
- e: Error
- messages: KafkaMessage[]
- batch: Omit<Batch, "messages">
Returns Promise<void>

Description
On catch error
- Defined in packages/@biorate/kafkajs/src/connectors/consumer.ts:78

`Protected` connect

connect(config): Promise<Consumer>
Parameters
- config: IKafkaJSConsumerConfig
Returns Promise<Consumer>

Description
Create connection
Overrides Connector.connect
- Defined in packages/@biorate/kafkajs/src/connectors/consumer.ts:62

connection

connection(name?): Consumer
Parameters
- Optional name: string
  Optional
Returns Consumer

Description
Method for get existed the connection
Inherited from Connector.connection
- Defined in packages/@biorate/connector/src/index.ts:113

create

create(config): Promise<Consumer>
Parameters
- config: IKafkaJSConsumerConfig
Returns Promise<Consumer>

Description
Method for creating new connection
Inherited from Connector.create
- Defined in packages/@biorate/connector/src/index.ts:97

get

get(name?): Consumer
Parameters
- Optional name: string
  Optional
Returns Consumer

Description
Alias for connection method
Inherited from Connector.get
- Defined in packages/@biorate/connector/src/index.ts:124

`Protected` initialize

initialize(): Promise<void>
Returns Promise<void>

Description
Initialize method
Inherited from Connector.initialize
- Defined in packages/@biorate/connector/src/index.ts:130

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
- Defined in packages/@biorate/kafkajs/src/connectors/consumer.ts:94

unsubscribe

unsubscribe(name): Promise<void>
Parameters
- name: string
Returns Promise<void>

Description
Unsubscribe
- Defined in packages/@biorate/kafkajs/src/connectors/consumer.ts:88

use

use(name): void
Parameters
- name: string
Returns void

Description
Method for changing current connection
Inherited from Connector.use
- Defined in packages/@biorate/connector/src/index.ts:105

Class KafkaJSConsumerConnector

Description

Features:

Example

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns KafkaJSConsumerConnector

Properties

Private #connections

Description

Private #connections

Description

Private #current

Description

Private #current

Description

Protected config

Description

Protected Readonly configs

Description

Protected counter

Description

Protected histogram

Description

Protected Readonly namespace

Description

Accessors

connections

Returns Map<string, T>

Description

current

Returns T

Description

Methods

Protected catch

Parameters

e: Error

messages: KafkaMessage[]

batch: Omit<Batch, "messages">

Returns Promise<void>

Description

Protected connect

Parameters

config: IKafkaJSConsumerConfig

Returns Promise<Consumer>

Description

connection

Parameters

Optional name: string

Returns Consumer

Description

create

Parameters

config: IKafkaJSConsumerConfig

Returns Promise<Consumer>

Description

get

Parameters

Optional name: string

Returns Consumer

Description

Protected initialize

Returns Promise<void>

Description

subscribe

Parameters

name: string

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

Parameters

messages: KafkaMessage[]

batch: Omit<Batch, "messages">

Returns Promise<void>

Returns Promise<void>

Description

`Private` #connections

`Private` #connections

`Private` #current

`Private` #current

`Protected` config

`Protected` `Readonly` configs

`Protected` counter

`Protected` histogram

`Protected` `Readonly` namespace

`Protected` catch

`Protected` connect

`Optional` name: string

`Optional` name: string

`Protected` initialize