periodic method

  1. @defineHook
TimerHook periodic(
  1. Duration duration,
  2. void callback(
    1. Timer timer
    ), {
  3. bool immediately = false,
})

Creates a periodic timer that invokes callback every duration.

callback receives the current Timer instance. Returns a TimerHook; call TimerHook.cancel to stop. TimerHook.tick increments on each callback.

Implementation

@defineHook
TimerHook periodic(Duration duration, void Function(Timer timer) callback,
    {bool immediately = false}) {
  return useHook(_TimerPeriodicHook(
      duration: duration, callback: callback, immediately: immediately));
}