Variable TimerManagerConst

Type declaration

• createRelativeTimer:function

  • createRelativeTimer(name, date, defaultActions?): undefined | KosTimer

  • Creates a new timer with a timeout relative to the current date.

    Parameters

    • name: string

      The name of the timer
    • date: Date

      The date to set the timer to
    • Optional defaultActions: TimerAction[]

      Optional default timer actions.

    Returns undefined | KosTimer

    the time instance

• createTimer:function

  • createTimer(name, timeout?, defaultActions?): undefined | KosTimer

  • Creates a new timer or retrieves an existing one by name.

    Parameters

    • name: string

      The name of the timer.
    • timeout: number = 60

      The duration (in seconds) of the timer (default: 60 seconds).
    • Optional defaultActions: TimerAction[]

      Optional default timer actions.

    Returns undefined | KosTimer

    The timer instance.

• getTimer:function

  • getTimer(name): undefined | KosTimer

  • Gets an existing timer by name.

    Parameters

    • name: string

      The name of the timer.

    Returns undefined | KosTimer

    The timer instance or undefined if not found.

• clearTimer:function

  • clearTimer(name): void

  • Clears (pauses) an existing timer by name.

    Parameters

    • name: string

      The name of the timer.

    Returns void

• restartTimer:function

  • restartTimer(name): void

  • Restarts an existing timer to its initial state by name. The timer will continue to run from its initial state.

    Parameters

    • name: string

      The name of the timer.

    Returns void

• resetTimer:function

  • resetTimer(name): void

  • Resets an existing timer to its initial state by name.

    Parameters

    • name: string

      The name of the timer.

    Returns void

• addTimeoutAction:function

  • addTimeoutAction(name, action): void

  • Adds a timeout action to an existing timer by name.

    Parameters

    • name: string

      The name of the timer.
    • action: TimerAction

      The timer action configuration to add.

    Returns void

• removeTimeoutAction:function

  • removeTimeoutAction(name, actionName): void

  • Removes a timeout action from an existing timer by name and action name.

    Parameters

    • name: string

      The name of the timer.
    • actionName: string

      The name of the action to remove.

    Returns void

• startTimer:function

  • startTimer(name): void

  • Starts an existing timer by name.

    Parameters

    • name: string

      The name of the timer.

    Returns void