Class Routine<T>

constructor

• new Routine<T = unknown>(cfg: RoutineConfig<T>): Routine<T>

  Type Parameters

  • T = unknown

  Parameters

  • cfg: RoutineConfig<T>

  Returns Routine<T>

Readonlyname

next

• next(from?: Date): Date

  When the next run is due, from from (default now).

  Parameters

  • from: Date = ...

  Returns Date

runNow

• runNow(): Promise<T | undefined>

  Runs once now, outside the schedule. If a run is already in progress, waits for it and returns its outcome instead.

  Returns Promise<T | undefined>

start

• start(): Promise<void>

  Schedules the ticks; with catchUp, runs first if a run was missed. Idempotent.

  Returns Promise<void>

state

• state(): Promise<RoutineState<T>>

  Returns Promise<RoutineState<T>>

stop

• stop(): Promise<void>

  Cancels the next tick and aborts a run in progress (its signal fires). Resolves once the run has ended.

  Returns Promise<void>