Interface ITimerOptions<T>
Type Parameters
T
Hierarchy
- ITimerOptions
Index
Properties
context
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 observable
Optional parameters when adding an observer to the observable
Type declaration
Optional insert
First?: boolean Optional mask?: number
Optional scope?: any
timeoutSearch playground for timeout
Time-to-end
Methods
Optional break
An optional break condition that will stop the times prematurely. In this case onEnded will not be triggered!
Parameters
Optional data: ITimerData<T>
Returns boolean
Optional on
Will be triggered when the break condition has met (prematurely ended)
Parameters
data: ITimerData<any>
Returns void
Optional on
Will be triggered when the time condition has met
Parameters
data: ITimerData<any>
Returns void
Optional on
Optional function to execute on each tick (or count)
Parameters
data: ITimerData<any>
Returns void
Construction options for a timer