Class MultiStageTimerInternal

constructor

• new MultiStageTimer(statistics, name, stages): MultiStageTimer

• Defines the MultiStageTimer with a list of timer names that represent its stages.

  Parameters

  • statistics: Statistics

    The statistics object that manages the timers.

  • name: string

    Name of this MultiStageTimer.

  • stages: string[]

    List of timer names.

  Returns MultiStageTimer

Readonly name

stages

stage

• get stage(): undefined | string

• Gets the current stage.

  Returns undefined | string
• set stage(stage): void

• Sets the current stage. If a new stage is provided, the current timer (if available) is stopped, and the next timer is started. If the timer in the next stage is undefined, this is equivalent to calling stop on the MultiStageTimer.

  Parameters

  • stage: undefined | string

    The next stage to start.

  Returns void

value

• get value(): undefined | number

• Gets the timer value for the last stage. If the MultiStageTimer did not finish its last stage, the value is undefined.

  Returns undefined | number

reset

• reset(): void

• Resets the timers across all stages.

  Returns void

start

• start(): number

• Starts the MultiStageTimer at its first stage.

  Returns number

stop

• stop(): number

• Stops the MultiStageTimer. Returns the measurement of the last stage, which may be undefined if not all stages started.

  Returns number