Options
All
  • Public
  • Public/Protected
  • All
Menu

@azure/event-hubs - v5.0.0

Package version

Index

Type aliases

ProcessCloseHandler

ProcessCloseHandler: function

Signature of the user provided function invoked by EventHubConsumerClient just after stopping to receive events from a partition.

Type declaration

ProcessErrorHandler

ProcessErrorHandler: function

Signature of the user provided function invoked by EventHubConsumerClient for errors that occur when receiving events or when executing any of the user provided functions passed to the subscribe() method.

Type declaration

    • Parameters

      Returns Promise<void>

ProcessEventsHandler

ProcessEventsHandler: function

Signature of the user provided function invoked by EventHubConsumerClient when a set of events is received.

Type declaration

ProcessInitializeHandler

ProcessInitializeHandler: function

Signature of the user provided function invoked by EventHubConsumerClient just before starting to receive events from a partition.

Type declaration

Variables

Const logger

logger: any = createClientLogger("event-hubs")

The @azure/logger configuration for this package. This will output logs using the azure:event-hubs namespace prefix.

Object literals

Const earliestEventPosition

earliestEventPosition: object

Gets the EventPosition corresponding to the location of the the first event present in the partition. Pass this position to the EventHubConsumerClient.subscribe() method to begin receiving events from the first event in the partition which has not expired due to the retention policy.

offset

offset: number = -1

Const latestEventPosition

latestEventPosition: object

Gets the EventPosition corresponding to the end of the partition. Pass this position to the EventHubConsumerClient.subscribe() method to begin receiving events from the event that is enqueued right after the method call.

returns

EventPosition

offset

offset: "@latest" = "@latest"

Generated using TypeDoc