Skip to main content
Version: 21.0.x

Interface: CreateCheckpointScheduleParams

api/procedures/types.CreateCheckpointScheduleParams

Properties

period

period: null | CalendarPeriod

The cadence with which to make Checkpoints.

Note

A null value indicates to create only one Checkpoint, regardless of repetitions specified. This can be used to schedule the creation of a Checkpoint in the future

Defined in

api/procedures/types.ts:617


repetitions

repetitions: null | BigNumber

The number of snapshots to take. A null value indicates snapshots should be made indefinitely

Defined in

api/procedures/types.ts:621


start

start: null | Date

The date from which to begin creating snapshots. A null value indicates immediately

Defined in

api/procedures/types.ts:612