Class KafkaJSAdminConnector

Description

KafkaJS admin connector

Features:

admin connector manager for KafkaJS

Example

Hierarchy

Connector<IKafkaJSAdminConfig, IKafkaJSAdminConnection>
- KafkaJSAdminConnector

Index

Constructors

Properties

#connections #connections #current #current config namespace

Accessors

connections current

Methods

connect connection create get initialize use

Constructors

constructor

new KafkaJSAdminConnector(): KafkaJSAdminConnector
Returns KafkaJSAdminConnector

Inherited from Connector.constructor

Properties

`Private` #connections

#connections: Map<string, Admin>

Description

Private connections storage

`Private` #connections

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

Description

Private connections storage

`Private` #current

#current: Admin

Description

Private link to selected (used) connection

`Private` #current

#current: Admin = undefined

Description

Private link to selected (used) connection

`Protected` config

config: IConfig

Description

Config dependency

`Protected` `Readonly` namespace

namespace: "KafkaJSAdmin" = 'KafkaJSAdmin'

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` connect

connect(config): Promise<Admin>
Parameters
- config: IKafkaJSAdminConfig
Returns Promise<Admin>

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

connection

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

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

create

create(config): Promise<Admin>
Parameters
- config: IKafkaJSAdminConfig
Returns Promise<Admin>

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

get

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

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

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

Generated using TypeDoc