Node SDK

Interface StatsStream

Legend

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

A pipeline step that is used to manually get/set the checkpoint. Often, this pipeline step is used to get and store checkpoints and then at the very end of the pipeline, it will use the saved off data to manaully checkpoint using StreamUtil.stats.

Note, this is only rarely used in special cases.

Hierarchy

  • Transform
    • StatsStream

Index

Properties

Properties

checkpoint

checkpoint: { (callback: Callback): void; (params: Checkpoint, callback: Callback): void }

Type declaration

    • Exposes a function to allow the developer to set the checkpoint.

      Parameters

      Returns void

    • Exposes a function to allow the developer to set the checkpoint.

      Parameters

      Returns void

get

get: () => CheckpointData

Type declaration

Generated using TypeDoc