Variable configConst

config: {
    tsconfig: {
        description: string;
        type: string;
    };
    typecheck: {
        description: string;
        type: string;
    };
} = ...

Options added by this plugin

Type declaration

  • tsconfig: {
        description: string;
        type: string;
    }

    Path to the tsconfig.json file containing project settings provided to ts-node when running tests.

    Similar to the --project option to ts-node. Sets the TS_NODE_PROJECT environment variable.

    If this is a relative directory, then it is resolved against the project root directory.

    Defaults to the first of these files that are found in the project root directory:

    • tsconfig.tap.json
    • tsconfig.test.json
    • tsconfig.spec.json
    • tsconfig.json
    • description: string
    • type: string
  • typecheck: {
        description: string;
        type: string;
    }

    flag

    Type-check test files, in addition to transpiling and running them.

    This defaults to false, even though type checking your tests is generally a good idea. Unfortunately, it is also often considerably slower, adding as much as 500-750ms to each test suite file, which can be painful if you have a lot of tests. In large project folders, the effect can be even more pronounced.

    It is a good idea to enable this in CI environments, where test speed is less of an ergonomic drawback.

    The "skipLibCheck": true option in tsconfig will also speed things up a bit, at the expense of some type safety.

    Note that even if you pre-compile your tests, they will still be subject to type checking if "allowJs": true is set in your tsconfig.

    • description: string
    • type: string

Generated using TypeDoc