Timer
Defined in: packages/core/src/time/timer.ts:5
A reusable timer that calls a callback function after a specified delay.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Timer(
callback,delayMs):Timer
Defined in: packages/core/src/time/timer.ts:14
Constructs a new Timer.
Parameters
Section titled “Parameters”callback
Section titled “callback”The function to call when the timer fires.
delayMs
Section titled “delayMs”number
The delay in milliseconds before the timer fires.
Returns
Section titled “Returns”Timer
Methods
Section titled “Methods”cancel()
Section titled “cancel()”cancel():
void
Defined in: packages/core/src/time/timer.ts:39
Cancels the timer. If the timer is not active, this does nothing.
Returns
Section titled “Returns”void
isActive()
Section titled “isActive()”isActive():
boolean
Defined in: packages/core/src/time/timer.ts:25
Returns whether the timer is currently active (i.e., has been started and not yet fired or canceled).
Returns
Section titled “Returns”boolean
True if the timer is active, false otherwise.
restart()
Section titled “restart()”restart():
void
Defined in: packages/core/src/time/timer.ts:47
Restarts the timer. If the timer is not active, this starts it.
Returns
Section titled “Returns”void
start()
Section titled “start()”start():
void
Defined in: packages/core/src/time/timer.ts:30
Starts the timer. If the timer is already active, this does nothing.
Returns
Section titled “Returns”void