Class PulsarStore

constructor

• new PulsarStore(options?: PulsarStoreOptions): PulsarStore

  Parameters

  • options: PulsarStoreOptions = {}

  Returns PulsarStore

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 pulsar-client Client for anything not wrapped here.

  Returns any

produce

• produce(topic: string, message: PulsarMessage): Promise<any>

  Produce message to topic. The producer for a topic is created on first use and cached, so repeated produce() calls to the same topic reuse it. message may be a UTF-8 string or a Buffer; it is serialized to raw bytes and sent as { data: Buffer }. Returns the producer's send result.

  Parameters

  • topic: string
  • message: PulsarMessage

  Returns Promise<any>

subscribe

• subscribe(
      topic: string,
      subscription: string,
      handler: (msg: any) => void | Promise<void>,
      options?: SubscribeOptions,
  ): Promise<any>

  Subscribe a consumer to topic under subscription and invoke handler for every received message. Runs a background receive loop that calls consumer.receive(), passes each message to handler, then acknowledges it with consumer.acknowledge(msg). The loop stops on disconnect(). The consumer is tracked so disconnect() closes it. Returns the created consumer.

  Parameters

  • topic: string
  • subscription: string
  • handler: (msg: any) => void | Promise<void>
  • options: SubscribeOptions = {}

  Returns Promise<any>

createReader

• createReader(topic: string, options?: ReaderOptions): Promise<any>

  Create a Pulsar reader over topic. Readers give non-destructive, position-controlled reads (no subscription/acks). The reader is tracked so disconnect() closes it. Returns the created reader.

  Parameters

  • topic: string
  • options: ReaderOptions = {}

  Returns Promise<any>