Skip to main content

toGithubBenchmark

@webda/bench


Function: toGithubBenchmark()

toGithubBenchmark(results): object

Defined in: packages/bench/src/reporters/github-benchmark.ts:39

Convert results to the github-action-benchmark formats

The action accepts one tool per file: throughput goes to customBiggerIsBetter, p99 latency to customSmallerIsBetter. Unstable results are excluded so they do not trigger false alerts.

Parameters​

results​

BenchResult[]

the results

Returns​

object

the entries of both files

biggerIsBetter​

biggerIsBetter: GithubBenchmarkEntry[]

smallerIsBetter​

smallerIsBetter: GithubBenchmarkEntry[]