Class Test<T>

Tracks a function's execution in {@link (Test:class).histogram}.

example

import { Test } from '@jonahsnider/benchmark';

const test = new Test(() => 'a' + 'b');

Type Parameters

T = unknown

Hierarchy

Test

Index

Constructors

constructor

Properties

histogram

Methods

run

Constructors

constructor

new Test<T>(implementation: (() => T | PromiseLike<T>)): Test<T>

- Defined in test.ts:47
Create a new {@link (Test:class)} with a given implementation.

You probably don't want to instantiate this class directly, instead you can register tests with {@link (Suite:class).(addTest:2)}. You can also register {@link (Test:class)} instances with {@link (Suite:class).(addTest:1)}.
example
```
const test = new Test(() => 'a' + 'b');
```
Type Parameters
- T = unknown
Parameters
- implementation: (() => T | PromiseLike<T>)
  
  The implementation function of the test
  - - (): T | PromiseLike<T>
    - Returns T | PromiseLike<T>
Returns Test<T>

Properties

Readonly histogram

histogram: RecordableHistogram = ...

Execution times for this {@link (Test:class)}'s implementation.

Methods

run

run(): Promise<T>

- Defined in test.ts:56
Runs this {@link (Test:class)}'s implementation once and records the execution time in {@link (Test:class).histogram}.

Returns Promise<T>
The return value of this {@link (Test:class)}'s implementation

Generated using TypeDoc