eslint-rule-benchmark/dist/core/benchmark/create-benchmark-config.d.ts

Benchmark ESLint rules with detailed performance metrics for CI and plugin development

import {
  BenchmarkConfig,
  ReporterOptions,
  WarmupConfig,
} from '../../types/benchmark-config'
/** Parameters for creating a benchmark configuration. */
interface CreateBenchmarkConfigParameters {
  /** Reporter configuration. */
  reporters?: Partial<ReporterOptions>[]
  /** Warmup configuration. */
  warmup?: Partial<WarmupConfig>
  /** Path to compare results against (if applicable). */
  baselinePath?: string
  /** Number of measurement iterations to perform. */
  iterations?: number
  /** Timeout in milliseconds for each test run. */
  timeout?: number
  /** Name of the benchmark. */
  name: string
}
/**
 * Creates a benchmark configuration with default settings.
 *
 * @param parameters - Parameters for the benchmark configuration.
 * @returns A configured benchmark configuration.
 */
export declare function createBenchmarkConfig(
  parameters: CreateBenchmarkConfigParameters,
): BenchmarkConfig
export {}