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