Skip to main content
Module

x/pretty_benching/mod.ts>prettyBenchmarkDownOptions

:sauropod: A small lib to make your Deno benchmarking progress and results look pretty
littletof/prettyBenching
Latest
interface prettyBenchmarkDownOptions
import { type prettyBenchmarkDownOptions } from "https://deno.land/x/pretty_benching@v0.3.3/mod.ts";

Defines how the generated markdown should look like.

Properties

optional
title: string

Defines a # title for the markdown

optional
description: string | ((results: BenchmarkRunResult) => string)

Defines a section right after the title. When a function is provided, it receives the run's results

optional
afterTables: string | ((results: BenchmarkRunResult) => string)

Defines a section at the end of the markdown. When a function is provided, it receives the run's results

optional
groups: GroupDefinition[]

Defines groups, into which the benchmarks will be groupped. Any benchmark result, that wasn't added into any group will be collected into one table called Ungroupped. One benchmark can be in multiple groups.

optional
columns: ColumnDefinition[]

Defines the columns of the markdown tables.