Class KafkaStore

constructor

• new KafkaStore(options?: KafkaStoreOptions): KafkaStore

  Parameters

  • options: KafkaStoreOptions = {}

  Returns KafkaStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): any

  Returns the underlying kafkajs Kafka client for anything not wrapped here.

  Returns any

produce

• produce(topic: string, messages: KafkaMessage[]): Promise<any>

  Produce one or more messages to topic. Returns kafkajs's record metadata (per-partition base offsets).

  Parameters

  • topic: string
  • messages: KafkaMessage[]

  Returns Promise<any>

createTopic

• createTopic(topic: string, opts?: CreateTopicOptions): Promise<boolean>

  Create topic via a short-lived admin connection. Returns kafkajs's boolean indicating whether the topic was newly created (false if it already existed).

  Parameters

  • topic: string
  • opts: CreateTopicOptions = {}

  Returns Promise<boolean>

listTopics

• listTopics(): Promise<string[]>

  List all topic names known to the cluster via a short-lived admin connection.

  Returns Promise<string[]>

subscribe

• subscribe(
      topics: string | string[],
      handler: (payload: any) => void | Promise<void>,
      options?: SubscribeOptions,
  ): Promise<any>

  Subscribe a new consumer to topics and invoke handler for each message (kafkajs's eachMessage payload: { topic, partition, message }). The consumer joins the group options.groupId (a generated id is used if omitted) and is tracked so disconnect() stops it. Returns the created kafkajs consumer.

  Parameters

  • topics: string | string[]
  • handler: (payload: any) => void | Promise<void>
  • options: SubscribeOptions = {}

  Returns Promise<any>