Node SDK

Interface Checkpoint

Legend

  • Namespace
  • Variable
  • Function
  • Function with type parameter
  • Type alias
  • Type alias with type parameter
  • Interface
  • Interface with type parameter
  • Property
  • Enumeration
  • Class

The type used to set the checkpoint on a bot in the RStreams bus bot DynamoDB table.

Hierarchy

  • Checkpoint

Index

Properties

Properties

eid

eid: string

The event ID to set as the checkpoint.

Optional ended_timestamp

ended_timestamp?: number

The ended timestamp.

Optional expected

expected?: string

Optional force

force?: boolean

If true, force the update even if the timestamp has changed since the last time we read it.

source_timestamp

source_timestamp: number

The source timestamp.

Optional started_timestamp

started_timestamp?: number

The started timestamp.

Optional type

type?: "write" | "read"

Whether updating the read or write checkpoint.

units

units: number

The units.

Generated using TypeDoc