Interface CustomProviderOptions

interface CustomProviderOptions {
    allowExternal?: boolean;
    clean?: boolean;
    cleanOnRerun?: boolean;
    customProviderModule: string;
    enabled?: boolean;
    exclude?: string[];
    extension?: string | string[];
    processingConcurrency?: number;
    reportOnFailure?: boolean;
    reportsDirectory?: string;
}

Hierarchy

Properties

allowExternal? clean? cleanOnRerun? customProviderModule enabled? exclude? extension? processingConcurrency? reportOnFailure? reportsDirectory?

Properties

Optional allowExternal

allowExternal?: boolean

Collect coverage of files outside the project root.

Default

false

Optional clean

clean?: boolean

Clean coverage results before running tests

Default

true

Optional cleanOnRerun

cleanOnRerun?: boolean

Clean coverage report on watch rerun

Default

true

customProviderModule

customProviderModule: string

Name of the module or path to a file to load the custom provider from

Optional enabled

enabled?: boolean

Enables coverage collection. Can be overridden using --coverage CLI option.

Default

false

Optional exclude

exclude?: string[]

List of files excluded from coverage as glob patterns

Optional extension

extension?: string | string[]

Extensions for files to be included in coverage

Default

['.js', '.cjs', '.mjs', '.ts', '.tsx', '.jsx', '.vue', '.svelte', '.marko']

Optional processingConcurrency

processingConcurrency?: number

Concurrency limit used when processing the coverage results. Defaults to Math.min(20, os.availableParallelism?.() ?? os.cpus().length)

Optional reportOnFailure

reportOnFailure?: boolean

Generate coverage report even when tests fail.

Default

false

Optional reportsDirectory

reportsDirectory?: string

Directory to write coverage report to

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc