KC's Workspace
    Preparing search index...

    Interface CoverageProvider

    interface CoverageProvider {
        clean: (clean?: boolean) => void | Promise<void>;
        generateCoverage: (reportContext: ReportContext) => unknown;
        initialize: (ctx: Vitest) => void | Promise<void>;
        mergeReports?: (coverages: unknown[]) => void | Promise<void>;
        name: string;
        onAfterSuiteRun: (meta: AfterSuiteRunMeta) => void | Promise<void>;
        onEnabled?: () => void | Promise<void>;
        onFileTransform?: (
            sourceCode: string,
            id: string,
            pluginCtx: any,
        ) => TransformResult | Promise<TransformResult>;
        onTestFailure?: () => void | Promise<void>;
        reportCoverage: (
            coverage: unknown,
            reportContext: ReportContext,
        ) => void | Promise<void>;
        requiresTransform?: (id: string) => boolean;
        resolveOptions: () => ResolvedCoverageOptions;
    }
    Index

    Properties

    clean generateCoverage initialize mergeReports? name onAfterSuiteRun onEnabled? onFileTransform? onTestFailure? reportCoverage requiresTransform? resolveOptions

    Properties

    clean: (clean?: boolean) => void | Promise<void>

    Callback to clean previous reports

    generateCoverage: (reportContext: ReportContext) => unknown

    Callback to generate final coverage results

    initialize: (ctx: Vitest) => void | Promise<void>

    Called when provider is being initialized before tests run

    mergeReports?: (coverages: unknown[]) => void | Promise<void>

    Callback for --merge-reports options. Called with multiple coverage results generated by generateCoverage.

    name: string
    onAfterSuiteRun: (meta: AfterSuiteRunMeta) => void | Promise<void>

    Called with coverage results after a single test file has been run

    onEnabled?: () => void | Promise<void>

    Callback that's called when the coverage is enabled via a programmatic enableCoverage API.

    onFileTransform?: (
        sourceCode: string,
        id: string,
        pluginCtx: any,
    ) => TransformResult | Promise<TransformResult>

    Callback called for instrumenting files with coverage counters.

    onTestFailure?: () => void | Promise<void>

    Callback called when test run fails

    reportCoverage: (
        coverage: unknown,
        reportContext: ReportContext,
    ) => void | Promise<void>

    Callback to convert coverage results to coverage reports. Called with results returned from generateCoverage

    requiresTransform?: (id: string) => boolean

    Return true if this file is transformed by the coverage provider. This is used to generate the persistent file hash by fsModuleCache

    resolveOptions: () => ResolvedCoverageOptions

    Called when setting coverage options for Vitest context (ctx.config.coverage)

    Settings

    Member Visibility

    On This Page

    Properties