Class PeriodicalTimer

constructor

• new PeriodicalTimer(
      callback: MaybeAsyncCallback,
      intervalMs: number,
      options?: PeriodicalTimerOptions,
  ): PeriodicalTimer

  Constructs a new PeriodicalTimer.

  Parameters

  • callback: MaybeAsyncCallback

    The callback function to call at each interval.

  • intervalMs: number

    The interval in milliseconds between each tick.

  • Optionaloptions: PeriodicalTimerOptions

    Optional settings for the timer.

  Returns PeriodicalTimer

ReadonlyintervalMs

isStarted

• isStarted(): boolean

  Returns whether the timer is currently started.

  Returns boolean

  True if the timer is started, false otherwise.

start

• start(): void

  Starts the periodical timer. If the timer is already started, this does nothing.

  Returns void

stop

• stop(): void

  Stops the periodical timer. If the timer is not started, this does nothing.

  Returns void