class ClientKafka extends ClientProxy {
constructor(options: { postfixId?: string; client?: KafkaConfig; consumer?: ConsumerConfig; run?: Omit<ConsumerRunConfig, "eachBatch" | "eachMessage">; ... 6 more ...; producerOnlyMode?: boolean; })
protected logger: Logger
protected client: Kafka | null
protected consumer: Consumer | null
protected producer: Producer | null
protected parser: KafkaParser | null
protected initialized: Promise<void> | null
protected responsePatterns: string[]
protected consumerAssignments: {...}
protected brokers: string[] | BrokersFunction
protected clientId: string
protected groupId: string
protected producerOnlyMode: boolean
protected options: KafkaOptions['options']
subscribeToResponseOf(pattern: any): void
close(): Promise<void>
connect(): Promise<Producer>
bindTopics(): Promise<void>
createClient<T = any>(): T
createResponseCallback(): (payload: EachMessagePayload) => any
getConsumerAssignments()
protected dispatchEvent(packet: OutgoingEvent): Promise<any>
protected getReplyTopicPartition(topic: string): string
protected publish(partialPacket: ReadPacket<any>, callback: (packet: WritePacket<any>) => any): () => void
protected getResponsePatternName(pattern: string): string
protected setConsumerAssignments(data: ConsumerGroupJoinEvent): void
protected initializeSerializer(options: { postfixId?: string; client?: KafkaConfig; consumer?: ConsumerConfig; run?: Omit<ConsumerRunConfig, "eachBatch" | "eachMessage">; ... 6 more ...; producerOnlyMode?: boolean; })
protected initializeDeserializer(options: { postfixId?: string; client?: KafkaConfig; consumer?: ConsumerConfig; run?: Omit<ConsumerRunConfig, "eachBatch" | "eachMessage">; ... 6 more ...; producerOnlyMode?: boolean; })
commitOffsets(topicPartitions: TopicPartitionOffsetAndMetadata[]): Promise<void>
protected routingMap: Map<string, Function>
protected serializer: ProducerSerializer
protected deserializer: ProducerDeserializer
abstract connect(): Promise<any>
abstract close(): any
send<TResult = any, TInput = any>(pattern: any, data: TInput): Observable<TResult>
emit<TResult = any, TInput = any>(pattern: any, data: TInput): Observable<TResult>
protected abstract publish(packet: ReadPacket<any>, callback: (packet: WritePacket<any>) => void): () => void
protected abstract dispatchEvent<T = any>(packet: ReadPacket<any>): Promise<T>
protected createObserver<T>(observer: Observer<T>): (packet: WritePacket) => void
protected serializeError(err: any): any
protected serializeResponse(response: any): any
protected assignPacketId(packet: ReadPacket<any>): ReadPacket & PacketId
protected connect$(instance: any, errorEvent: string = ERROR_EVENT, connectEvent: string = CONNECT_EVENT): Observable<any>
protected getOptionsProp<T extends ClientOptions['options'], K extends keyof T>(obj: T, prop: K, defaultValue: T[K] = undefined)
protected normalizePattern(pattern: MsPattern): string
protected initializeSerializer(options: { url?: string; maxSendMessageLength?: number; maxReceiveMessageLength?: number; maxMetadataSize?: number; keepalive?: { keepaliveTimeMs?: number; keepaliveTimeoutMs?: number; keepalivePermitWithoutCalls?: number; http2MaxPingsWithoutData?: number; http2MinTimeBetweenPingsMs?: number; http2MinPingIntervalWithoutData...)
protected initializeDeserializer(options: { url?: string; maxSendMessageLength?: number; maxReceiveMessageLength?: number; maxMetadataSize?: number; keepalive?: { keepaliveTimeMs?: number; keepaliveTimeoutMs?: number; keepalivePermitWithoutCalls?: number; http2MaxPingsWithoutData?: number; http2MinTimeBetweenPingsMs?: number; http2MinPingIntervalWithoutData...)
}
Constructor
constructor(options: { postfixId?: string; client?: KafkaConfig; consumer?: ConsumerConfig; run?: Omit<ConsumerRunConfig, "eachBatch" | "eachMessage">; ... 6 more ...; producerOnlyMode?: boolean; })
Parameters
| Option |
Type |
Description |
options
|
object |
|
|
Properties
| Property |
Description |
protected logger: Logger
|
|
protected client: Kafka | null
|
|
protected consumer: Consumer | null
|
|
protected producer: Producer | null
|
|
protected parser: KafkaParser | null
|
|
protected initialized: Promise<void> | null
|
|
protected responsePatterns: string[]
|
|
protected consumerAssignments: {
[key: string]: number;
}
|
|
protected brokers: string[] | BrokersFunction
|
|
protected clientId: string
|
|
protected groupId: string
|
|
protected producerOnlyMode: boolean
|
|
protected options: KafkaOptions['options']
|
Read-only.
Declared in constructor.
|
Methods
subscribeToResponseOf()
|
subscribeToResponseOf(pattern: any): void
Parameters
| Option |
Type |
Description |
pattern
|
any |
|
Returns
void
|
close()
|
close(): Promise<void>
Parameters
There are no parameters.
Returns
Promise<void>
|
connect()
|
connect(): Promise<Producer>
Parameters
There are no parameters.
Returns
Promise<Producer>
|
bindTopics()
|
bindTopics(): Promise<void>
Parameters
There are no parameters.
Returns
Promise<void>
|
createClient()
|
createClient<T = any>(): T
Parameters
There are no parameters.
Returns
T
|
createResponseCallback()
|
createResponseCallback(): (payload: EachMessagePayload) => any
Parameters
There are no parameters.
Returns
(payload: EachMessagePayload) => any
|
getConsumerAssignments()
|
getConsumerAssignments()
Parameters
There are no parameters.
|
dispatchEvent()
|
protected dispatchEvent(packet: OutgoingEvent): Promise<any>
Parameters
Returns
Promise<any>
|
getReplyTopicPartition()
|
protected getReplyTopicPartition(topic: string): string
Parameters
| Option |
Type |
Description |
topic
|
string |
|
Returns
string
|
publish()
|
protected publish(partialPacket: ReadPacket<any>, callback: (packet: WritePacket<any>) => any): () => void
Parameters
Returns
() => void
|
getResponsePatternName()
|
protected getResponsePatternName(pattern: string): string
Parameters
| Option |
Type |
Description |
pattern
|
string |
|
Returns
string
|
setConsumerAssignments()
|
protected setConsumerAssignments(data: ConsumerGroupJoinEvent): void
Parameters
| Option |
Type |
Description |
data
|
ConsumerGroupJoinEvent |
|
Returns
void
|
initializeSerializer()
|
protected initializeSerializer(options: { postfixId?: string; client?: KafkaConfig; consumer?: ConsumerConfig; run?: Omit<ConsumerRunConfig, "eachBatch" | "eachMessage">; ... 6 more ...; producerOnlyMode?: boolean; })
Parameters
| Option |
Type |
Description |
options
|
object |
|
|
initializeDeserializer()
|
protected initializeDeserializer(options: { postfixId?: string; client?: KafkaConfig; consumer?: ConsumerConfig; run?: Omit<ConsumerRunConfig, "eachBatch" | "eachMessage">; ... 6 more ...; producerOnlyMode?: boolean; })
Parameters
| Option |
Type |
Description |
options
|
object |
|
|
commitOffsets()
|
commitOffsets(topicPartitions: TopicPartitionOffsetAndMetadata[]): Promise<void>
Parameters
| Option |
Type |
Description |
topicPartitions
|
TopicPartitionOffsetAndMetadata[] |
|
Returns
Promise<void>
|