benchmark_format.ts

view source

Declarations
#

7 declarations

benchmark_format_json
#

benchmark_format.ts view source

(results: BenchmarkResult[], options?: BenchmarkFormatJsonOptions | undefined): string import {benchmark_format_json} from '@fuzdev/fuz_util/benchmark_format.js';

Format results as JSON.

results

type BenchmarkResult[]

options?

type BenchmarkFormatJsonOptions | undefined
optional

returns

string

examples

console.log(format_json(results)); console.log(format_json(results, {pretty: false})); console.log(format_json(results, {include_timings: true}));

benchmark_format_markdown
#

benchmark_format.ts view source

(results: BenchmarkResult[], baseline?: string | undefined): string import {benchmark_format_markdown} from '@fuzdev/fuz_util/benchmark_format.js';

Format results as a Markdown table with key metrics. All times use the same unit for easy comparison.

results

type BenchmarkResult[]

baseline?

optional task name to use as baseline for comparison (defaults to fastest)

type string | undefined
optional

returns

string

throws

  • Error - if `baseline` is provided but no result has that name

examples

console.log(benchmark_format_markdown(results)); // | Task Name | ops/sec | p50 (μs) | p75 (μs) | p90 (μs) | p95 (μs) | p99 (μs) | min (μs) | max (μs) | vs Best | // |------------|------------|----------|----------|----------|----------|----------|----------|----------|----------| // | slugify v2 | 1,237,144 | 0.81 | 0.85 | 0.89 | 0.95 | 1.20 | 0.72 | 2.45 | baseline | // | slugify | 261,619 | 3.82 | 3.95 | 4.12 | 4.35 | 5.10 | 3.21 | 12.45 | 4.73x |

benchmark_format_markdown_grouped
#

benchmark_format.ts view source

(results: BenchmarkResult[], groups: BenchmarkGroup[]): string import {benchmark_format_markdown_grouped} from '@fuzdev/fuz_util/benchmark_format.js';

Format results as grouped Markdown tables with headers between groups.

results

type BenchmarkResult[]

groups

type BenchmarkGroup[]

returns

string

examples

const groups = [ { name: 'Fast Paths', filter: (r) => r.name.includes('fast'), baseline: 'fast/reference' }, { name: 'Slow Paths', filter: (r) => r.name.includes('slow') }, ]; console.log(benchmark_format_markdown_grouped(results, groups)); // ### Fast Paths // | Task Name | ops/sec | ... | vs fast/reference | // |-----------|---------|-----|-------------------| // | ... | ... | ... | ... | // // ### Slow Paths // | Task Name | ops/sec | ... | vs Best | // |-----------|---------|-----|---------| // | ... | ... | ... | ... |

benchmark_format_number
#

benchmark_format.ts view source

(n: number, decimals?: number) => string import {benchmark_format_number} from '@fuzdev/fuz_util/benchmark_format.js';

Format a number with fixed decimal places and thousands separators.

see also

  • ``format_number`` in maths.ts for the underlying implementation.

benchmark_format_table
#

benchmark_format.ts view source

(results: BenchmarkResult[], baseline?: string | undefined): string import {benchmark_format_table} from '@fuzdev/fuz_util/benchmark_format.js';

Format results as an ASCII table with percentiles, min/max, and relative performance. All times use the same unit for easy comparison.

results

type BenchmarkResult[]

baseline?

optional task name to use as baseline for comparison (defaults to fastest)

type string | undefined
optional

returns

string

throws

  • Error - if `baseline` is provided but no result has that name

examples

console.log(benchmark_format_table(results)); // ┌─────────────┬────────────┬──────────┬──────────┬──────────┬──────────┬──────────┬──────────┬──────────┬──────────┐ // │ Task Name │ ops/sec │ p50 (μs) │ p75 (μs) │ p90 (μs) │ p95 (μs) │ p99 (μs) │ min (μs) │ max (μs) │ vs Best │ // ├─────────────┼────────────┼──────────┼──────────┼──────────┼──────────┼──────────┼──────────┼──────────┼──────────┤ // │ slugify v2 │ 1,237,144 │ 0.81 │ 0.85 │ 0.89 │ 0.95 │ 1.20 │ 0.72 │ 2.45 │ baseline │ // │ slugify │ 261,619 │ 3.82 │ 3.95 │ 4.12 │ 4.35 │ 5.10 │ 3.21 │ 12.45 │ 4.73x │ // └─────────────┴────────────┴──────────┴──────────┴──────────┴──────────┴──────────┴──────────┴──────────┴──────────┘

benchmark_format_table_grouped
#

benchmark_format.ts view source

(results: BenchmarkResult[], groups: BenchmarkGroup[]): string import {benchmark_format_table_grouped} from '@fuzdev/fuz_util/benchmark_format.js';

Format results as a grouped table with visual separators between groups.

results

type BenchmarkResult[]

groups

type BenchmarkGroup[]

returns

string

examples

const groups = [ { name: 'FAST PATHS', filter: (r) => r.name.includes('fast') }, { name: 'SLOW PATHS', filter: (r) => r.name.includes('slow') }, ]; console.log(benchmark_format_table_grouped(results, groups)); // 📦 FAST PATHS // ┌────┬─────────────┬────────────┬...┐ // │ 🐆 │ fast test 1 │ 1,237,144 │...│ // │ 🐇 │ fast test 2 │ 261,619 │...│ // └────┴─────────────┴────────────┴...┘ // // 📦 SLOW PATHS // ┌────┬─────────────┬────────────┬...┐ // │ 🐢 │ slow test 1 │ 10,123 │...│ // └────┴─────────────┴────────────┴...┘

BenchmarkFormatJsonOptions
#

benchmark_format.ts view source

BenchmarkFormatJsonOptions import type {BenchmarkFormatJsonOptions} from '@fuzdev/fuz_util/benchmark_format.js';

pretty?

Whether to pretty-print (default: true)

type boolean

include_timings?

Whether to include raw timings array (default: false, can be large)

type boolean

Depends on
#

Imported by
#