Class AdvancedTimer<T>

constructor

• new AdvancedTimer<T = any>(options: ITimerOptions<T>): AdvancedTimer<T>

  Will construct a new advanced timer based on the options provided. Timer will not start until start() is called.

  Type Parameters

  • T = any

  Parameters

  • options: ITimerOptions<T>

    construction options for this advanced timer

  Returns AdvancedTimer<T>

onEachCountObservable

onStateChangedObservable

onTimerAbortedObservable

onTimerEndedObservable

breakCondition

• set breakCondition(predicate: (data: ITimerData<T>) => boolean): void

  set a breaking condition for this timer. Default is to never break during count

  Parameters

  • predicate: (data: ITimerData<T>) => boolean

    the new break condition. Returns true to break, false otherwise

  Returns void

clearObservables

• clearObservables(): void

  Reset ALL associated observables in this advanced timer

  Returns void

dispose

• dispose(): void

  Dispose this timer, clearing all resources

  Returns void

start

• start(timeToEnd?: number): void

  Will start a new iteration of this timer. Only one instance of this timer can run at a time.

  Parameters

  • timeToEnd: number = ...

    how much time to measure until timer ended

  Returns void

stop

• stop(): void

  Will force a stop on the next tick.

  Returns void