Class: LegacyTimer
A class to create, start, and stop named timers that measure elapsed time in milliseconds.
Deprecated
Use Timer class instead. To migrate to the Timer class, use Timer.startNew() to create and start a new timer instead of LegacyTimer.start().
Constructors
new LegacyTimer()
new LegacyTimer(
name):LegacyTimer
Parameters
• name: string
Returns
Defined in
LegacyTimer.ts:22
Methods
elapsed()
staticelapsed(name):number
Returns the total time elapsed, in milliseconds, of the timer.
Parameters
• name: string
The name of the timer whose elapsed duration is requested
Returns
number
Remarks
The total time elapsed will include all durations from multiple starts and stops of the timer, if applicable. A timer's elapsed duration can be read while it is in started or stopped state. The method throws an error if a timer with the given name does not exist.
Deprecated
Use Timer class.
Defined in
LegacyTimer.ts:140
exists()
staticexists(name):boolean
Checks if a timer of the given name exists.
Parameters
• name: string
The name of the timer to check for existence
Returns
boolean
boolean
Remarks
The method checks if there is a timer with the given name.
Deprecated
Use Timer class.
Defined in
LegacyTimer.ts:203
now()
staticnow():number
Aliases performance.now()
Returns
number
Remarks
The m2c2kit Timer class is designed to measure elapsed durations after a designated start point for a uniquely named timer. However, if a timestamp based on the time origin is needed, this method can be used.
Deprecated
Use Timer class.
Defined in
LegacyTimer.ts:39
remove()
staticremove(name):void
Removes a timer.
Parameters
• name: string
The name of the timer to be removed
Returns
void
Remarks
After removal, no additional methods can be used with a timer of the given name, other than to start a new timer with the given name, whose duration will begin at 0 again. The method throws an error if a timer with the given name does not exist.
Deprecated
Use Timer class.
Defined in
LegacyTimer.ts:168
removeAll()
staticremoveAll():void
Remove all timers.
Returns
void
Remarks
This method will remove any timers in a started or stopped state. This method is idempotent; method is safe to call even if there are no timers to remove; no errors are thrown if there are not any timers that can be removed.
Deprecated
Use Timer class.
Defined in
LegacyTimer.ts:189
restart()
staticrestart(name):void
Restarts a timer.
Parameters
• name: string
The name of the timer to be restarted
Returns
void
Remarks
The timer elapsed duration is set to 0 and it starts anew. The method throws an error if a timer with the given name does not exist (if there is not a started or stopped timer with the given name).
Deprecated
Use Timer class. Use Timer.startNew() to create and start a new timer with the same name.
Defined in
LegacyTimer.ts:115
start()
staticstart(name):void
Starts a millisecond-resolution timer based on performance.now().
Parameters
• name: string
The name of the timer to be started
Returns
void
Remarks
The method throws an error if a timer with the given name is already in a started state.
Deprecated
Use Timer class. Use Timer.startNew() to create and start a new timer or Timer.new() to create a new timer without starting it.
Defined in
LegacyTimer.ts:54
stop()
staticstop(name):void
Stops a timer.
Parameters
• name: string
The name of the timer to be stopped
Returns
void
Remarks
The method throws an error if a timer with the given name is already in a stopped state, or if a timer with the given name has not been started.
Deprecated
Use Timer class.
Defined in
LegacyTimer.ts:83