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.GroupDefinition

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

Defines a group in the markdown.

Properties

include: RegExp

Collects the benchmarks into the group, which name mathes the RegExp

name: string

Defines the name of the group, which will be a ## Title in the markdown

optional
columns: ColumnDefinition[]

Defines the columns of the markdown table in the specific group. Overrides root and default column options.

optional
description: string | ((
groupResults: BenchmarkResult[],
runResults: BenchmarkRunResult,
) => string)

Defines a section right after the group title. When a function is provided, it receives the run's results for the benchmarks in the group, the group's definition and the overall benchmark results.

optional
afterTable: string | ((
groupResults: BenchmarkResult[],
runResults: BenchmarkRunResult,
) => string)

Defines a section at the end of the group. When a function is provided, it receives the run's results for the benchmarks in the group, the group's definition and the overall benchmark results.