Skip to main content

Interface: SuiteReporter

Properties​

onBenchmarkEnd()?​

optional onBenchmarkEnd: (benchmarkName, results) => void

Called after each benchmark completes.

Parameters​

• benchmarkName: string

The name of the benchmark

• results: Result[]

The results for the benchmark

Returns​

void

Defined in​

src/api-types.ts:48

onBenchmarkStart()?​

optional onBenchmarkStart: (benchmarkName) => void

Called before each benchmark starts.

Parameters​

• benchmarkName: string

The name of the benchmark

Returns​

void

Defined in​

src/api-types.ts:41

onSuiteStart()?​

optional onSuiteStart: (suiteName) => void

Called before the suite starts running.

Parameters​

• suiteName: string

The name of the suite

Returns​

void

Defined in​

src/api-types.ts:35

report()​

report: (results) => void

Called after all benchmarks complete.

Parameters​

• results: Record<string, Result[]>

All benchmark results keyed by benchmark name

Returns​

void

Defined in​

src/api-types.ts:54