Class Timer

constructor

• new Timer(interval: number, autoStart?: boolean, ...args: any[]): Timer

  Constructs a new instance of the timer

  Note: If additional arguments are specified, then those arguments will be provided with every tick event emitted except arguments that may be included with calls to the tick() method.

  Parameters

  • interval: number
  • autoStart: boolean = false
  • ...args: any[]

  Returns Timer

interval

paused

destroyed

• get destroyed(): boolean

  Returns if the timer has been destroyed

  Returns boolean

destroy

• destroy(): void

  Destroys the timer

  Note: This is destructive, once destroyed, it cannot be restarted

  Returns void

start

• start(): void

  Starts the timer

  Returns void

stop

• stop(): void

  Stops the timer

  Returns void

tick

• tick(...args: any[]): void

  Forces a tick event to be emitted with the specified arguments

  Parameters

  • ...args: any[]

  Returns void

toggle

• toggle(): boolean

  Toggles the timer on/off

  Returns boolean

  boolean whether the timer is running or not