Class Timer

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

Index

Constructors

Properties

onInvoke onStart? onStop? rate reference? repeat

Accessors

createMethod started stopped

Methods

invoke start stop

Constructors

constructor

new Timer(data: TimerInit): Timer
Creates a new Timer instance.
Parameters
- data: TimerInit
  The configuration data for the timer.
Returns Timer

Properties

`Private` `Readonly`onInvoke

onInvoke: () => void

Invoked on timer invoke.

`Private` `Optional` `Readonly`onStart

onStart?: () => void

Invoked when timer starts.

`Private` `Optional` `Readonly`onStop

onStop?: () => void

Invoked when timer stops.

`Private` `Readonly`rate

rate: number

Timer rate in milliseconds.

`Private` `Optional`reference

reference?: number

Reference of the active timer.

`Private` `Readonly`repeat

repeat: boolean

Is this a repeating timer?

Accessors

`Private`createMethod

get createMethod(): (handler: TimerHandler, timeout: number) => number
Gets the method used to create the timer (interval or timeout).

Returns (handler: TimerHandler, timeout: number) => number
The timer creation method.

started

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

Returns boolean
A boolean indicating if the timer has started.

stopped

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

Returns boolean
A boolean indicating if the timer has stopped.

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

start

start(): void
Starts the timer.

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

Returns void

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