Class: Suite
Constructors
new Suite()
new Suite(
name,options?):Suite
Parameters
• name: string
• options?: SuiteOptions
Returns
Defined in
Methods
addBenchmark()
addBenchmark(
benchmark):Suite
Parameters
• benchmark: Benchmark
Returns
Defined in
run()
run():
Promise<Record<string,Result[]>>
Returns
Promise<Record<string, Result[]>>
Defined in
withBenchmarkReporter()
withBenchmarkReporter(
reporter):Suite
Parameters
• reporter: BenchmarkReporter
Returns
Defined in
withErrorStrategy()
withErrorStrategy(
errorStrategy,opts?):Suite
Sets the error strategy for the suite and optionally for the benchmarks.
Parameters
• errorStrategy: ErrorStrategy
Determines what to do when an error occurs during a benchmark run. See ErrorStrategy
• opts?
Options for the error strategy. If shouldSetOnBenchmarks is true, the error strategy will be set on all benchmarks in the suite.
• opts.shouldSetOnBenchmarks?: boolean
Returns
Defined in
withReporter()
withReporter(
reporter):Suite
Parameters
• reporter: SuiteReporter
Returns
Defined in
withVariation()
withVariation(
variation):Suite
Parameters
• variation: Variation
Returns
Defined in
withVariations()
withVariations(
variations):Suite
Parameters
• variations: Variation[]