types.ts

import type { SuiteAPI, ExpectStatic, TestAPI } from 'vitest';

export interface BenchmarkCase {
  readonly moduleName: string;

  // execute the actual benchmark function
  run(): void;

  // run the benchmarks vitest test
  test(describe: SuiteAPI, expect: ExpectStatic, test: TestAPI): void;
}

export abstract class Benchmark<Fn> implements BenchmarkCase {
  // name of the module that is benchmarked
  readonly moduleName: string;

  // the function that implements the benchmark
  readonly fn: Fn;

  constructor(moduleName: string, fn: Fn) {
    this.moduleName = moduleName;
    this.fn = fn;
  }

  // execute the actual benchmark function
  abstract run(): void;

  // run the benchmarks vitest test
  abstract test(describe: SuiteAPI, expect: ExpectStatic, test: TestAPI): void;
}

// Aliased any.
// Need to use ´any` for libraries that do not accept `unknown` as data input
// to their parse/assert functions.
// eslint-disable-next-line @typescript-eslint/no-explicit-any
export type UnknownData = any;

export interface BenchmarkResult {
  name: string;
  benchmark: string;
  runtime: string;
  runtimeVersion: string;
  ops: number;
  margin: number;
}