KInterval

class KInterval(scope: CoroutineScope, val period: Duration?, block: suspend () -> Unit)(source)

A repeating interval that invokes block every period.

Port of the useInterval React hook.

val interval = KInterval(scope = viewModelScope, period = 1.seconds) {
    println("tick")
}
// Stops:
interval.clear()

Pass null for period to create the interval in a paused state (call set later).

scope

CoroutineScope that owns the interval job.

period

Time between invocations. Pass null to start paused.

block

Suspending action called on each tick.

Constructors

constructor(scope: CoroutineScope, period: Duration?, block: suspend () -> Unit)

fun clear()

Stops the interval.

fun set()

Starts the interval. No-op if period is null. Cancels any existing job first.