cardiologist/io.github.kevincianfarini.cardiologist/fixedPeriodPulse

fixedPeriodPulse

@ExperimentalTime
fun Clock.fixedPeriodPulse(period: Duration): Pulse

Return a Pulse which beats every period.

The period cadence which this Pulse beats is defined as the time between the start of one beat and the scheduled start of the subsequent beat. The returned Pulse will delay for period prior to its first beat.

@ExperimentalTime
fun Clock.fixedPeriodPulse(period: DateTimePeriod, timeZone: TimeZone): Pulse

Return a Pulse which beats every period in timeZone.

The period cadence which this Pulse beats is defined as the time between the start of one beat and the scheduled start of the subsequent beat. The returned Pulse will delay for period prior to its first beat.