Function benchmark

benchmark<A>(
    name: string,
    options: {
        args?: any[];
        print?: boolean;
        skip?: boolean;
        timeout?: number;
        warmup?: number;
    } & { args: A[] },
    fn: (arg: A) => any,
): Promise<void>
Runs a benchmark
Type Parameters
- A
Parameters
- name: string
  Name of the benchmark
- options: {
      args?: any[];
      print?: boolean;
      skip?: boolean;
      timeout?: number;
      warmup?: number;
  } & { args: A[] }
  Benchmark options
  - Optionalargs?: any[]
    Array of arguments to pass to the benchmark function
  - Optionalprint?: boolean
    Print benchmark results to console (default: true)
  - Optionalskip?: boolean
    Skip this benchmark
  - Optionaltimeout?: number
    Timeout in milliseconds (default: 1000)
  - Optionalwarmup?: number
    Number of warmup iterations to run before the benchmark (default: 0)
  - args: A[]
- fn: (arg: A) => any
  Function to benchmark
Returns Promise<void>
- Defined in src/benchmark.d.ts:35
benchmark(
    name: string,
    options: {
        args?: any[];
        print?: boolean;
        skip?: boolean;
        timeout?: number;
        warmup?: number;
    } & { args?: undefined },
    fn: (arg: number) => any,
): Promise<void>
Runs a benchmark
Parameters
- name: string
  Name of the benchmark
- options: {
      args?: any[];
      print?: boolean;
      skip?: boolean;
      timeout?: number;
      warmup?: number;
  } & { args?: undefined }
  Benchmark options
  - Optionalargs?: any[]
    Array of arguments to pass to the benchmark function
  - Optionalprint?: boolean
    Print benchmark results to console (default: true)
  - Optionalskip?: boolean
    Skip this benchmark
  - Optionaltimeout?: number
    Timeout in milliseconds (default: 1000)
  - Optionalwarmup?: number
    Number of warmup iterations to run before the benchmark (default: 0)
  - Optionalargs?: undefined
- fn: (arg: number) => any
  Function to benchmark
Returns Promise<void>
- Defined in src/benchmark.d.ts:40