Construction options for a timer

Type parameters

  • T


  • ITimerOptions



Optional breakCondition

Find examples in Playground
breakCondition: function

An optional break condition that will stop the times prematurely. In this case onEnded will not be triggered!

Type declaration


Find examples in Playground
contextObservable: Observable<T>

The context observable is used to calculate time deltas and provides the context of the timer's callbacks. Will usually be OnBeforeRenderObservable. Countdown calculation is done ONLY when the observable is notifying its observers, meaning that if you choose an observable that doesn't trigger too often, the wait time might extend further than the requested max time

Optional observableParameters

Find examples in Playground
observableParameters: object

Optional parameters when adding an observer to the observable

Type declaration

  • Optional insertFirst?: boolean
  • Optional mask?: number
  • Optional scope?: any

Optional onAborted

Find examples in Playground
onAborted: function

Will be triggered when the break condition has met (prematurely ended)

Type declaration

Optional onEnded

Find examples in Playground
onEnded: function

Will be triggered when the time condition has met

Type declaration

Optional onTick

Find examples in Playground
onTick: function

Optional function to execute on each tick (or count)

Type declaration


Find examples in Playground
timeout: number


Generated using TypeDoc