Skip to main content
Module

x/pretty_benching/benchmark_result_card.ts>prettyBenchmarkCardResultOptions

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

Defines the options for card formatted results

Properties

optional
thresholds: Thresholds

If provided, the measured values will be colored accordingly in the card. Also needed, if parts.threshold is set to true

optional
indicators: BenchIndicator[]

If provided, the indicators will be placed for the specific benches

optional
nocolor: boolean

Strips all default colors from the output.

Note: it doesnt strip the colors that come through user defined thresholds and indicators

optional
parts: { extraMetrics?: boolean; threshold?: boolean; graph?: boolean; graphBars?: number; }

Overrides the default card parts option, which is {graph: true, graphBars: 5}

optional
infoCell: (result: BenchmarkResult, options: prettyBenchmarkCardResultOptions) => string

Add a cell with the generated content at the end of the header row of the result card. Overflowing text is cut.