Skip to main content

Class: MarkdownSuiteReporter

Implements​

Constructors​

new MarkdownSuiteReporter()​

new MarkdownSuiteReporter(opts): MarkdownSuiteReporter

Parameters​

• opts

• opts.fields?: ("git" | "min" | "max" | "average" | "p95" | "failed" | "failureRate" | "iterations" | "totalDuration" | "benchmarkName" | "variationName")[]

• opts.outputFile: string

• opts.title?: string

Returns​

MarkdownSuiteReporter

Defined in​

src/reporters/markdown-suite-reporter.ts:17

Properties​

fields​

fields: ("git" | "min" | "max" | "average" | "p95" | "failed" | "failureRate" | "iterations" | "totalDuration" | "benchmarkName" | "variationName")[]

Defined in​

src/reporters/markdown-suite-reporter.ts:15

outputFile​

outputFile: string

Defined in​

src/reporters/markdown-suite-reporter.ts:13

report()​

report: (results) => void

Called after all benchmarks complete.

Parameters​

• results: Record<string, Result[]>

All benchmark results keyed by benchmark name

Returns​

void

Implementation of​

SuiteReporter.report

Defined in​

src/reporters/markdown-suite-reporter.ts:66

title​

title: string

Defined in​

src/reporters/markdown-suite-reporter.ts:14