KC's Workspace
    Preparing search index...

    Interface BenchmarkUserOptions

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

    Properties

    compare? exclude? include? includeSamples? includeSource? outputFile? outputJson? reporters?

    Properties

    compare?: string

    benchmark output file to compare against

    exclude?: string[]

    Exclude globs for benchmark test files

    ['**/node_modules/**', '**/dist/**', '**/cypress/**', '**/.{idea,git,cache,output,temp}/**', '**/{karma,rollup,webpack,vite,vitest,jest,ava,babel,nyc,cypress,tsup,build,eslint,prettier}.config.*']
    include?: string[]

    Include globs for benchmark test files

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

    Include samples array of benchmark results for API or custom reporter usages. This is disabled by default to reduce memory usage.

    false
    includeSource?: string[]

    Include globs for in-source benchmark test files

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

    Use benchmark.outputJson instead

    outputJson?: string

    benchmark output file

    reporters?: Arrayable<"default" | "verbose" | string & {} | Reporter>

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

    ['default']

    Settings

    Member Visibility

    On This Page

    Properties