Skip to main content
Module

x/velo/dev_deps.ts>prettyBenchmarkDown

Performant Cache implementations for Deno. Supports LRU, LFU, ARC and other caching policies.
Go to Latest
function prettyBenchmarkDown
Re-export
import { prettyBenchmarkDown } from "https://deno.land/x/velo@0.1.5/dev_deps.ts";

Returns a function that expects a BenchmarkRunResult, which than prints the results in a nicely formatted markdown, based on the provided options.

Without options, one markdown table will be generated, containing all the bench results.

Typical basic usage:

// add benches, then
runBenchmarks().then(prettyBenchmarkDown(console.log));
// or write to file
runBenchmarks().then(prettyBenchmarkDown((markdown: string) => { Deno.writeTextFileSync("./benchmark.md", markdown); });

.

Parameters

outputFn: (out: string) => void
optional
options: prettyBenchmarkDownOptions