Class Measurements<T>

Allows to measure keys of type T with a Stopwatch.

Measure with start, measure or measureAsync, retrieve the final measurements with get.

Type Parameters

T

Index

Constructors

Methods

get measure measureAsync start

Constructors

constructor

new Measurements<T>(): Measurements<T>
Type Parameters
- T
Returns Measurements<T>

Methods

get

get(): Map<T, bigint>
Retrieve all measure-results, requires that all stop-watches that have been started have also been stopped.

Returns Map<T, bigint>
- Defined in src/benchmark/stopwatch.ts:82

measure

measure<Out>(key, fn): Out
Automatically call start and the corresponding stop to measure the execution time of the given function.
Type Parameters
- Out
Parameters
- key: T
- fn: (() => Out)
  - - (): Out
    - Returns Out
Returns Out
See
measureAsync
- Defined in src/benchmark/stopwatch.ts:57

measureAsync

measureAsync<Out>(key, fn): Promise<Out>
Similar to measure, but await the promise as part of the measurement
Type Parameters
- Out
Parameters
- key: T
  The key to write the resulting measurement to
- fn: (() => Promise<Out>)
  The function to measure
  - - (): Promise<Out>
    - Returns Promise<Out>
Returns Promise<Out>
See
measure
- Defined in src/benchmark/stopwatch.ts:73

start

start(key): IStoppableStopwatch
Start a timer for the given key, and guards that this is the first time this key is started. Call IStoppableStopwatch#stop on the returned stopwatch to stop the timer.
Parameters
- key: T
Returns IStoppableStopwatch
- Defined in src/benchmark/stopwatch.ts:44