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
TypeDescription
checkpointsCheckpoints

A reference to the Checkpoints object that changed.

checkpointIdId

The Id of the checkpoint that changed.

returnsvoid

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.