benchmark_types.ts

Target duration to run each benchmark task in milliseconds. The benchmark will run until this duration is reached or max_iterations is hit. Default: 1000ms

Number of warmup iterations before actual measurements. Warmup helps stabilize JIT compilation and caches. Default: 5

Cooldown time between tasks in milliseconds. Helps prevent interference between benchmarks. Default: 100ms

Minimum number of iterations to run. Default: 10

Maximum number of iterations to run. Prevents infinite loops if function is extremely fast. Default: 100000

Custom timer to use for measurements. Default: timer_default (auto-detects environment)

Callback invoked after each iteration completes. Useful for triggering garbage collection, logging progress, early termination, or custom instrumentation.

Note: The callback time is NOT included in iteration measurements - it runs after the timing capture. However, frequent GC calls will slow overall benchmark execution time.

Callback invoked after each task completes. Useful for logging progress during long benchmark runs.

Group results by category using filter functions.

Display name for the group

Optional description shown below the group name

Filter function to determine which results belong to this group

Task name to use as baseline for the "vs" column. When specified, ratios are computed against this task instead of the fastest. If the baseline task is not found in the group, falls back to "vs Best" with a warning.

Task name

Statistical analysis of the benchmark

Number of iterations executed

Total time spent benchmarking (including warmup) in milliseconds

Raw timing data for each iteration in nanoseconds. Useful for custom statistical analysis, histogram generation, or exporting to external tools.

Name of the task (for display)

Function to benchmark (sync or async). Return values are ignored.

Optional setup function run before benchmarking this task. Not included in timing measurements.

Optional teardown function run after benchmarking this task. Not included in timing measurements.

If true, skip this task during benchmark runs. Useful for temporarily disabling tasks during development.

If true, run only this task (and other tasks marked only). Useful for focusing on specific tasks during development.

Hint for whether the function is sync or async. If not provided, automatically detected during warmup. Setting this explicitly skips per-iteration promise checking for sync functions.