Interface BenchmarkUserOptions

interface BenchmarkUserOptions {
    exclude?: string[];
    include?: string[];
    includeSource?: string[];
    outputFile?: string | Partial<Record<"default" | "json" | "verbose", string>> & Record<string, string>;
    reporters?: Arrayable<"default" | "json" | "verbose" | Reporter>;
}

Properties

exclude? include? includeSource? outputFile? reporters?

Properties

Optional exclude

exclude?: string[]

Exclude globs for benchmark test files

Default

['node_modules', 'dist', '.idea', '.git', '.cache']

Optional include

include?: string[]

Include globs for benchmark test files

Default

['**/*.{bench,benchmark}.?(c|m)[jt]s?(x)']

Optional includeSource

includeSource?: string[]

Include globs for in-source benchmark test files

Default

[]

Optional outputFile

outputFile?: string | Partial<Record<"default" | "json" | "verbose", string>> & Record<string, string>

Write test results to a file when the --reporter=json option is also specified. Also definable individually per reporter by using an object instead.

Optional reporters

reporters?: Arrayable<"default" | "json" | "verbose" | Reporter>

Custom reporter for output. Can contain one or more built-in report names, reporter instances, and/or paths to custom reporters

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc