Class EventHubsStore

constructor

• new EventHubsStore(options?: EventHubsStoreOptions): EventHubsStore

  Parameters

  • options: EventHubsStoreOptions = {}

  Returns EventHubsStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): EventHubProducerLike

  Returns the underlying default EventHubProducerClient for anything not wrapped here.

  Returns EventHubProducerLike

publish

• publish(eventHubName: string, message: EventHubsMessage): Promise<void>

  Send one message to eventHubName (or the store's default hub) as a single-event batch via EventHubProducerClient.sendBatch. The message is encoded per the module's rules (string/Buffer as-is, else JSON string).

  Parameters

  • eventHubName: string
  • message: EventHubsMessage

  Returns Promise<void>

subscribe

• subscribe(
      eventHubName: string,
      handler: (event: any) => void | Promise<void>,
      options?: EventHubsSubscribeOptions,
  ): Promise<EventHubsSubscription>

  Subscribe a new EventHubConsumerClient to eventHubName, invoking handler once per received event. Returns a subscription whose stop() closes both the underlying subscription and consumer client; the subscription is tracked so disconnect() closes it too.

  Parameters

  • eventHubName: string
  • handler: (event: any) => void | Promise<void>
  • options: EventHubsSubscribeOptions = {}

  Returns Promise<EventHubsSubscription>