`CheckpointListener`

The CheckpointListener type describes a function that is used to listen to changes to a checkpoint's label in a Checkpoints object.

(
  checkpoints: Checkpoints,
  checkpointId: Id,
): void

	Type	Description
`checkpoints`	`Checkpoints`	A reference to the `Checkpoints` object that changed.
`checkpointId`	`Id`	The `Id` of the checkpoint that changed.
returns	`void`	This has no return value.

A CheckpointListener is provided when using the addCheckpointListener method. See that method for specific examples.

When called, a CheckpointListener is given a reference to the Checkpoints object, and the Id of the checkpoint whose label changed.

Since

v1.0.0