@gobstones/gobstones-scripts
Version:
Scripts to abstract away build configuration of Gobstones Project's libraries and modules.
32 lines • 992 B
TypeScript
/**
* This type represents the options that you can pass to the jest task.
*/
export interface TaskJestOptions {
/**
* Whether to use coverage configurations to run the tests. Defaults to true.
*/
coverage: boolean;
/**
* Whether to disable the default thresholds for coverage. Defaults to false.
*/
noThreshold: boolean;
/**
* Whether you want to watch for changes. Defaults to false.
*/
watch: boolean;
}
/**
* Returns the string for the bash command to run
* jest command with the gobstones-script detected configuration.
* If any test contains the ".only" call, only run that specific file
* (This only works on UNIX based systems, not Windows). You may modify
* the behavior based on arguments.
*
* @param options - The nps action to run.
*
* @example jest({ coverage: true })
*
* @returns The bash command string.
*/
export declare const jest: (options?: TaskJestOptions) => string;
//# sourceMappingURL=jest.d.ts.map