Skip to main content

Class: MarkdownBenchmarkReporter

Implements​

Constructors​

new MarkdownBenchmarkReporter()​

new MarkdownBenchmarkReporter(opts): MarkdownBenchmarkReporter

Parameters​

• opts

• opts.append?: boolean

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

• opts.outputFile: string

Returns​

MarkdownBenchmarkReporter

Defined in​

src/reporters/markdown-benchmark-reporter.ts:20

Properties​

append​

append: boolean

Defined in​

src/reporters/markdown-benchmark-reporter.ts:16

fields​

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

Defined in​

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

outputFile​

outputFile: string

Defined in​

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

report()​

report: (benchmark, results) => void

Parameters​

• benchmark: Benchmark

• results: Result[]

Returns​

void

Implementation of​

BenchmarkReporter.report

Defined in​

src/reporters/markdown-benchmark-reporter.ts:69

Methods​

clear()​

clear(): void

Clears the output file. Useful when re-running benchmarks.

Returns​

void

Defined in​

src/reporters/markdown-benchmark-reporter.ts:209