Class Timer

Represents a timer that can be started, stopped, and repeated at a specified rate.

Index

Constructors

Accessors

started stopped

Methods

invoke start stop

Constructors

constructor

new Timer(data): Timer
Creates a new Timer instance.
Parameters
- data: TimerInit
  The configuration data for the timer.
Returns Timer
- Defined in src/classes/timer.ts:71

Accessors

started

get started(): boolean
Determines whether the timer has started.

Returns boolean
A boolean indicating if the timer has started.
- Defined in src/classes/timer.ts:55

stopped

get stopped(): boolean
Determines whether the timer has stopped.

Returns boolean
A boolean indicating if the timer has stopped.
- Defined in src/classes/timer.ts:63

Methods

invoke

invoke(): void
Triggers the callback function associated with the timer. This method can be called manually to simulate the timer invocation.

Returns void
- Defined in src/classes/timer.ts:121

start

start(): void
Starts the timer.

If the timer is already started, it will be stopped first and then restarted.

Returns void
- Defined in src/classes/timer.ts:90

stop

stop(): void
Stops the timer if it is currently running. If the timer is a repeating timer, it will be stopped using clearInterval. If the timer is a non-repeating timer, it will be stopped using clearTimeout.

Returns void
- Defined in src/classes/timer.ts:105