Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PartitionContext

Package version

Interface that describes the context passed to each of the functions that are a part of the SubscriptionEventHandlers. When implementing any of these functions, use the context object to get information about the partition as well as the ability to checkpoint.

Hierarchy

  • PartitionContext

Index

Properties

consumerGroup

consumerGroup: string

The consumer group name.

eventHubName

eventHubName: string

The event hub name.

fullyQualifiedNamespace

fullyQualifiedNamespace: string

The fully qualified Event Hubs namespace. This is likely to be similar to .servicebus.windows.net

Optional lastEnqueuedEventProperties

lastEnqueuedEventProperties: LastEnqueuedEventProperties

Information on the last enqueued event in the partition that is being processed. This property is only updated if the trackLastEnqueuedEventProperties option is set to true when creating an instance of EventProcessor.

readonly

partitionId

partitionId: string

The identifier of the Event Hub partition.

Methods

updateCheckpoint

  • Updates the checkpoint using the event data.

    A checkpoint is meant to represent the last successfully processed event by the user from a particular partition of a consumer group in an Event Hub instance.

    Parameters

    • eventData: ReceivedEventData

      The event that you want to update the checkpoint with.

    Returns Promise<void>

Generated using TypeDoc