SubscriptionOptions | @azure/event-hubs

Options for subscribe.

Hierarchy

OptionalEventHandlers
EventProcessorOptions
- SubscriptionOptions

Index

Properties

Optional defaultEventPosition

defaultEventPosition: EventPosition

The event position to use when claiming a partition if not already initialized.

Defaults to EventPosition.earliest()

maxBatchSize

maxBatchSize: number

The max size of the batch of events passed each time to user code for processing.

maxWaitTimeInSeconds

maxWaitTimeInSeconds: number

The maximum amount of time to wait to build up the requested message count before passing the data to user code for processing. If not provided, it defaults to 60 seconds.

Optional onClose

onClose: OnCloseHandler

Called when we stop processing events from a partition.

Optional onError

onError: OnErrorHandler

Called when errors occur during event receiving.

Optional onInitialize

onInitialize: OnInitializeHandler

Called when we first start processing events from a partition.

Optional trackLastEnqueuedEventInfo

trackLastEnqueuedEventInfo: undefined | false | true

property

Indicates whether or not the consumer should request information on the last enqueued event on its associated partition, and track that information as events are received.

When information about the partition's last enqueued event is being tracked, each event received from the Event Hubs service will carry metadata about the partition that it otherwise would not. This results in a small amount of additional network bandwidth consumption that is generally a favorable trade-off when considered against periodically making requests for partition properties using the Event Hub client.