TimerOptions
Defined in: plugins/TimerPlugin.ts:9
Configuration options for creating a timer.
Properties
Section titled “Properties”autoStart?
Section titled “autoStart?”
optional
autoStart:boolean
Defined in: plugins/TimerPlugin.ts:13
Whether to start the timer immediately upon creation
duration?
Section titled “duration?”
optional
duration:number
Defined in: plugins/TimerPlugin.ts:11
Duration in milliseconds. If not provided, timer counts up indefinitely
optional
loop:boolean
Defined in: plugins/TimerPlugin.ts:15
Whether to restart the timer when it completes
onComplete()?
Section titled “onComplete()?”
optional
onComplete: () =>void
Defined in: plugins/TimerPlugin.ts:21
Callback fired when the timer completes. Not called in count-up mode
Returns
Section titled “Returns”void
onTick()?
Section titled “onTick()?”
optional
onTick: (remaining
) =>void
Defined in: plugins/TimerPlugin.ts:23
Callback fired on each timer tick with the remaining time (or elapsed time in count-up mode)
Parameters
Section titled “Parameters”remaining
Section titled “remaining”number
Returns
Section titled “Returns”void
useWorker?
Section titled “useWorker?”
optional
useWorker:boolean
Defined in: plugins/TimerPlugin.ts:17
Run timer in a web worker for better performance and independence from main thread
workerInterval?
Section titled “workerInterval?”
optional
workerInterval:number
Defined in: plugins/TimerPlugin.ts:19
Update interval in milliseconds for worker-based timers. Default is 16ms (roughly 60fps)