Class: Stopwatch
@sapphire/stopwatch.Stopwatch
Stopwatch class, uses native node to replicate/extend performance-now dependency.
Constructors
constructor
• new Stopwatch(digits?
)
Starts a new stopwatch
Parameters
Name | Type | Default value |
---|---|---|
digits | number | 2 |
Defined in
Properties
#end
• Private
#end: null
| number
The end time of this stopwatch
Defined in
#start
• Private
#start: number
The start time of this stopwatch
Defined in
digits
• digits: number
The number of digits to appear after the decimal point when returning the friendly duration.
Defined in
Accessors
duration
• get
duration(): number
The duration of this stopwatch since start or start to end if this stopwatch has stopped.
Returns
number
Defined in
running
• get
running(): boolean
If the stopwatch is running or not.
Returns
boolean
Defined in
Methods
reset
▸ reset(): Stopwatch
Resets the Stopwatch to 0 duration (Returns a stopped state)
Returns
Defined in
restart
▸ restart(): Stopwatch
Restarts the stopwatch (Returns a running state)
Returns
Defined in
start
▸ start(): Stopwatch
Starts the Stopwatch
Returns
Defined in
stop
▸ stop(): Stopwatch
Stops the Stopwatch, freezing the duration
Returns
Defined in
toString
▸ toString(): string
Defines toString behavior
Returns
string