Class KosTimer

Manages the behavior of a timer.

Index

Constructors

Methods

start pause restart reset addTimeoutAction removeTimeoutAction

Constructors

constructor

new KosTimer(name, timeout, defaultActions?): KosTimer
Creates a new timer.
Parameters
- name: string
  The name of the timer.
- timeout: number | KosConfigProperty<number>
  The duration (in seconds) of the timer.
- Optional defaultActions: TimerAction[]
  Optional default timer actions.
Returns KosTimer

Methods

start

start(): void
Starts the timer.

Returns void

pause

pause(): void
Pauses the timer.

Returns void

restart

restart(): void
Restarts the timer. The timer will continue to run from its initial state.

Returns void

reset

reset(): void
Resets the timer to its initial state. The timer will be stopped and reset to its initial state. The timer will need to be started again to continue running.

Returns void

addTimeoutAction

addTimeoutAction(timerAction): void
Adds a timeout action to the timer.
Parameters
- timerAction: TimerAction
  The timer action configuration to add.
Returns void

removeTimeoutAction

removeTimeoutAction(actionName): void
Removes a timeout action from the timer by action name.
Parameters
- actionName: string
  The name of the action to remove.
Returns void