Skip to main content
Module

x/pretty_benching/mod.ts

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

Classes

Handles and enforces the set rules on the historic benchmarking data.

Functions

Calculates the min, max, mean (as (max+min)/2) and median from the measuredRunsMs array.

Calculates the standard deviation from the measuredRunsMs array.

Calculates Thresholds from the historic data for each benchmark.

Defines the default ColumnDefinitions, which are Name, Runs, Total (ms) and Average (ms)

Defines a delta column, which shows the changes for the benchmark. Shows - when there was no previous measurements for the benchmark in the history.

Returns the calculated delta for the specific benchmark in a formatted string.

Returns the calculated delta for the specific benchmark in a formatted string.

Defines multiple columns, which contain extra calculated values, like max, min, mean, median, stdDeviation.

Returns the range into which the benchmarks with had a threshold set fell.

Defines a column for each different runBenchmarks results in the history.

Defines a column which contains the indicators for the benchmarks, where provided.

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

Returns a function that expects BenchmarkRunProgress object, which than prints the benchmarking progress in a nicely formatted way, based on the provided options.

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

Defines a threshold result column, which shows into which range the benchmark fell. Shows - when no Threshold was provided for the given benchmark.

Defines a threshold result column, which shows the threshold ranges for the benchmark. Shows - when no Threshold was provided for the given benchmark.

Interfaces

Defines an indicator that should be used for the matching benches

Represents the stored historic benchmark data

Represents the results of one runBenchmarks run.

Represents the results of one benchmark's single run.

Defines one column of the markdown table.

Represent the change in a variable's value.

Defines a group in the markdown.

Defines how the generated markdown should look like.

Defines the rules on what and how the history should contain.

Defines how the resulting output should look like.

Defines a threshold, which has three sections.

Defines Threshold-s for specific benches. Each key of this object should correspond to a specific benchmark's name

Type Aliases

Defines how the resulting output should look like.

Defines which strict rules to use.