Skip to main content
Using Deno in production at your company? Earn free Deno merch.
Give us feedback
Module

x/merlin/deps.ts>pretty_benching.prettyBenchmarkDownOptions

Testing and Benchmarking framework for deno 🧙‍♂️
Latest
interface pretty_benching.prettyBenchmarkDownOptions
import { type pretty_benching } from "https://deno.land/x/merlin@v1.0.7/deps.ts";
const { prettyBenchmarkDownOptions } = pretty_benching;

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.