Skip to main content

MarkdownReporter

@webda/bench

Class: MarkdownReporter

Defined in: packages/bench/src/reporters/markdown.ts:46

Append the results to the GitHub step summary (GITHUB_STEP_SUMMARY) when available

Implements​

Constructors​

Constructor​

new MarkdownReporter(file?, title?): MarkdownReporter

Defined in: packages/bench/src/reporters/markdown.ts:51

Parameters​

file?​

string | undefined = process.env.GITHUB_STEP_SUMMARY

markdown file to append to, defaults to GITHUB_STEP_SUMMARY

title?​

string = "Webda benchmarks"

title of the table

Returns​

MarkdownReporter

Properties​

file​

protected file: string | undefined = process.env.GITHUB_STEP_SUMMARY

Defined in: packages/bench/src/reporters/markdown.ts:52

markdown file to append to, defaults to GITHUB_STEP_SUMMARY

title​

protected title: string = "Webda benchmarks"

Defined in: packages/bench/src/reporters/markdown.ts:53

title of the table

Methods​

report()​

report(results): void

Defined in: packages/bench/src/reporters/markdown.ts:59

Parameters​

results​

BenchResult[]

Returns​

void

Implementation of​

Reporter.report