c8js
    Preparing search index...

    Variable defaultConst

    default: {
        checkCoverage: typeof checkCoverage;
        commands: typeof commands;
        exec: typeof exec;
        report: typeof report;
        version: typeof version;
        (
            command: string | Promise<string>,
            options?: default.Options,
        ): Promise<default.Result>;
        (
            command: string | Promise<string>,
            args?: readonly string[],
            options?: default.Options,
        ): Promise<default.Result>;
    }

    Executes a command, generates a coverage report and optionally checks that code coverage is within the specified thresholds.

    By default, if the command exits with a nonzero code this function will throw an error without generating a coverage report. This behavior can be changed with the option throwExecError.

    This function does not spawn a shell to parse the command line, so don't put any additional spaces or quotes around the command or the arguments.

    Type declaration

    The command to run. This can be a binary executable or a Node.js module. If a promise is specified, the resolved value will be used.

    A list of arguments passed to the command.

    Options for the function.

    A promise that settles after the command has terminated. The promise will resolve with an object similar to the return value of child_process.spawnSync with an additional property holding the coverage map. If the option checkCoverage (or [100] 100) is set to true and code coverage is under the specified thresholds, the promise will reject with a LowCoverageError.

    Settings

    Member Visibility