Interface TypecheckConfig

interface TypecheckConfig {
    allowJs?: boolean;
    checker: string & Record<never, never> | "tsc" | "vue-tsc";
    enabled?: boolean;
    exclude: string[];
    ignoreSourceErrors?: boolean;
    include: string[];
    only?: boolean;
    tsconfig?: string;
}

Properties

allowJs? checker enabled? exclude ignoreSourceErrors? include only? tsconfig?

Properties

Optional allowJs

allowJs?: boolean

Check JS files that have @ts-check comment. If you have it enabled in tsconfig, this will not overwrite it.

checker

checker: string & Record<never, never> | "tsc" | "vue-tsc"

What tools to use for type checking.

Optional enabled

enabled?: boolean

Run typechecking tests alongisde regular tests.

exclude

exclude: string[]

Pattern for files that should not be treated as test files

Optional ignoreSourceErrors

ignoreSourceErrors?: boolean

Do not fail, if Vitest found errors outside the test files.

include

include: string[]

Pattern for files that should be treated as test files

Optional only

only?: boolean

When typechecking is enabled, only run typechecking tests.

Optional tsconfig

tsconfig?: string

Path to tsconfig, relative to the project root.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc