benchmark_baseline.ts

Benchmark baseline storage and comparison utilities.
Save benchmark results to disk and compare against baselines for regression detection.

Declarations
#

12 declarations

view source

benchmark_baseline_compare
#

benchmark_baseline.ts view source

(results: BenchmarkResult[], options?: BenchmarkBaselineCompareOptions): Promise<BenchmarkBaselineComparisonResult>

Compare benchmark results against the stored baseline.

`results`

current benchmark results

type BenchmarkResult[]

`options`

comparison options including regression threshold and staleness warning

type BenchmarkBaselineCompareOptions

default {}

returns

Promise<BenchmarkBaselineComparisonResult>

comparison result with regressions, improvements, and unchanged tasks

examples

const bench = new Benchmark();
bench.add('test', () => fn());
await bench.run();

const comparison = await benchmark_baseline_compare(bench.results(), {
  regression_threshold: 1.05, // Only flag regressions 5% or more slower
  staleness_warning_days: 7,  // Warn if baseline is older than 7 days
});
if (comparison.regressions.length > 0) {
  console.log('Performance regressions detected!');
  for (const r of comparison.regressions) {
    console.log(`  ${r.name}: ${r.comparison.speedup_ratio.toFixed(2)}x slower`);
  }
  process.exit(1);
}

benchmark_baseline_format
#

benchmark_baseline.ts view source

(result: BenchmarkBaselineComparisonResult): string

Format a baseline comparison result as a human-readable string.

`result`

comparison result from benchmark_baseline_compare

type BenchmarkBaselineComparisonResult

returns

string

formatted string summary

benchmark_baseline_format_json
#

benchmark_baseline.ts view source

(result: BenchmarkBaselineComparisonResult, options?: { pretty?: boolean | undefined; }): string

Format a baseline comparison result as JSON for programmatic consumption.

`result`

comparison result from benchmark_baseline_compare

type BenchmarkBaselineComparisonResult

`options`

formatting options

type { pretty?: boolean | undefined; }

default {}

returns

string

JSON string

benchmark_baseline_load
#

benchmark_baseline.ts view source

(options?: BenchmarkBaselineLoadOptions): Promise<{ version: number; timestamp: string; git_commit: string | null; git_branch: string | null; node_version: string; entries: { ...; }[]; } | null>

Load the current baseline from disk.

`options`

load options

type BenchmarkBaselineLoadOptions

default {}

returns

Promise<{ version: number; timestamp: string; git_commit: string | null; git_branch: string | null; node_version: string; entries: { name: string; mean_ns: number; p50_ns: number; std_dev_ns: number; ... 7 more ...; sample_size: number; }[]; } | null>

the baseline, or null if not found or invalid

examples

const baseline = await benchmark_baseline_load();
if (baseline) {
  console.log(`Baseline from ${baseline.timestamp}`);
}

benchmark_baseline_save
#

benchmark_baseline.ts view source

(results: BenchmarkResult[], options?: BenchmarkBaselineSaveOptions): Promise<void>

Save benchmark results as the current baseline.

`results`

benchmark results to save

type BenchmarkResult[]

`options`

save options

type BenchmarkBaselineSaveOptions

default {}

returns

Promise<void>

examples

const bench = new Benchmark();
bench.add('test', () => fn());
await bench.run();
await benchmark_baseline_save(bench.results());