Skip to main content

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​

NameTypeDefault value
digitsnumber2

Defined in​

index.ts:23

Properties​

#end​

• Private #end: null | number

The end time of this stopwatch

Defined in​

index.ts:18

#start​

• Private #start: number

The start time of this stopwatch

Defined in​

index.ts:13

digits​

• digits: number

The number of digits to appear after the decimal point when returning the friendly duration.

Defined in​

index.ts:8

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​

index.ts:32

running​

• get running(): boolean

If the stopwatch is running or not.

Returns​

boolean

Defined in​

index.ts:39

Methods​

reset​

▸ reset(): Stopwatch

Resets the Stopwatch to 0 duration (Returns a stopped state)

Returns​

Stopwatch

Defined in​

index.ts:55

restart​

▸ restart(): Stopwatch

Restarts the stopwatch (Returns a running state)

Returns​

Stopwatch

Defined in​

index.ts:46

start​

▸ start(): Stopwatch

Starts the Stopwatch

Returns​

Stopwatch

Defined in​

index.ts:64

stop​

▸ stop(): Stopwatch

Stops the Stopwatch, freezing the duration

Returns​

Stopwatch

Defined in​

index.ts:76

toString​

▸ toString(): string

Defines toString behavior

Returns​

string

Defined in​

index.ts:84