Options
All
  • Public
  • Public/Protected
  • All
Menu

Module CheckpointInfo

Package version

Describes the checkoint information.

namespace

CheckpointInfo

Index

Properties

Functions

Properties

offset

offset: string
property

{string} offset The offset of the event to be checked in.

partitionId

partitionId: string
property

{string} partitionId The EventHub partition id.

sequenceNumber

sequenceNumber: number
property

{string} sequenceNumber The sequence number of the event to be checked in.

Functions

create

  • create(partitionId: string, offset?: undefined | string, sequenceNumber?: undefined | number): CheckpointInfo

  • Creates the checkpoint info

    Parameters

    • partitionId: string

      The partition id for the checkpoint

    • Optional offset: undefined | string
    • Optional sequenceNumber: undefined | number

    Returns CheckpointInfo

    CheckpointInfo

createFromEventData

  • createFromEventData(partitionId: string, eventData: EventData): CheckpointInfo

  • Creates the checkpoint info.

    Parameters

    • partitionId: string

      The partition id for the checkpoint

    • eventData: EventData

      The event data from which the checkpoint info needs to created.

    Returns CheckpointInfo

    CheckpointInfo

createFromLease

Generated using TypeDoc