api.procedures.createCheckpointSchedule.CreateCheckpointScheduleParams

Interface: CreateCheckpointScheduleParams

api/procedures/createCheckpointSchedule.CreateCheckpointScheduleParams

Table of contents

Properties

• period
• repetitions
• start

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/createCheckpointSchedule.ts:30

---

repetitions

• repetitions: null | BigNumber

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

Defined in

api/procedures/createCheckpointSchedule.ts:34

---

start

• start: null | Date

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

Defined in

api/procedures/createCheckpointSchedule.ts:25