Class Timer

constructor

• new Timer(interval, autoStart?, ...args): 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
  • Rest ...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

off

• off(event, listener): this

• Event that is emitted only once when we start the timer

  Parameters

  • event: "start"
  • listener: (() => void)
    • • (): void

      • Returns void

  Returns this
• off(event, listener): this

• Event that is emitted only once when we stop the timer

  Parameters

  • event: "stop"
  • listener: (() => void)
    • • (): void

      • Returns void

  Returns this
• off(event, listener): this

• Event that is emitted only once when a tick occurs

  Parameters

  • event: "tick"
  • listener: ((...args) => void)
    • • (...args): void

      • Parameters

        • Rest ...args: any[]

        Returns void

  Returns this
• off(event, listener): this

• Event that is emitted only once when we have an error

  Parameters

  • event: "error"
  • listener: ((error) => void)
    • • (error): void

      • Parameters

        • error: Error

        Returns void

  Returns this

on

• on(event, listener): this

• Event that is emitted every time a tick occurs

  Parameters

  • event: "tick"
  • listener: ((...args) => void)
    • • (...args): void

      • Parameters

        • Rest ...args: any[]

        Returns void

  Returns this
• on(event, listener): this

• Event that is emitted when we have an error

  Parameters

  • event: "error"
  • listener: ((error) => void)
    • • (error): void

      • Parameters

        • error: Error

        Returns void

  Returns this
• on(event, listener): this

• Event that is emitted when we start the timer

  Parameters

  • event: "start"
  • listener: (() => void)
    • • (): void

      • Returns void

  Returns this
• on(event, listener): this

• Event that is emitted when we stop the timer

  Parameters

  • event: "stop"
  • listener: (() => void)
    • • (): void

      • Returns void

  Returns this

once

• once(event, listener): this

• Event that is emitted only once when we start the timer

  Parameters

  • event: "start"
  • listener: (() => void)
    • • (): void

      • Returns void

  Returns this
• once(event, listener): this

• Event that is emitted only once when we stop the timer

  Parameters

  • event: "stop"
  • listener: (() => void)
    • • (): void

      • Returns void

  Returns this
• once(event, listener): this

• Event that is emitted only once when a tick occurs

  Parameters

  • event: "tick"
  • listener: ((...args) => void)
    • • (...args): void

      • Parameters

        • Rest ...args: any[]

        Returns void

  Returns this
• once(event, listener): this

• Event that is emitted only once when we have an error

  Parameters

  • event: "error"
  • listener: ((error) => void)
    • • (error): void

      • Parameters

        • error: Error

        Returns void

  Returns this

start

• start(): void

• Starts the timer

  Returns void

stop

• stop(): void

• Stops the timer

  Returns void

tick

• tick(...args): void

• Forces a tick event to be emitted with the specified arguments

  Parameters

  • Rest ...args: any[]

  Returns void

toggle

• toggle(): boolean

• Toggles the timer on/off

  Returns boolean

  boolean whether the timer is running or not