Skip to main content

Class: BenchmarkRunner

Defined in: src/benchmark/BenchmarkRunner.ts:7

Runner that executes benchmark scenarios with warmup, high-precision timing, percentile distributions, and terminal table formatting.

Constructors​

Constructor​

new BenchmarkRunner(): BenchmarkRunner

Returns​

BenchmarkRunner

Methods​

add()​

add(scenario): this

Defined in: src/benchmark/BenchmarkRunner.ts:13

Registers a new benchmark scenario.

Parameters​

ParameterType
scenarioBenchmarkScenario

Returns​

this


addRange()​

addRange(scenarios): this

Defined in: src/benchmark/BenchmarkRunner.ts:21

Registers multiple benchmark scenarios.

Parameters​

ParameterType
scenariosBenchmarkScenario[]

Returns​

this


run()​

run(options?): Promise<BenchmarkResult[]>

Defined in: src/benchmark/BenchmarkRunner.ts:29

Runs all registered scenarios matching the filter options.

Parameters​

ParameterType
optionsBenchmarkOptions

Returns​

Promise<BenchmarkResult[]>


printResultsTable()​

printResultsTable(results): void

Defined in: src/benchmark/BenchmarkRunner.ts:138

Pretty-prints results in a formatted terminal table.

Parameters​

ParameterType
resultsBenchmarkResult[]

Returns​

void