BettererOptionsResults
API > @betterer/betterer > BettererOptionsResults
Options for when you create a BettererResultsSummary via the betterer.results() API.
Signature
export interface BettererOptionsResults
Remarks
The options object will be validated by Betterer and turned into a BettererConfig.
Properties
| Property | Type | Description |
|---|---|---|
| configPaths? | BettererOptionsPaths | (Optional) A path to a test definition file containing Betterer tests, or an array of them. All configPaths should be relative to the cwd. |
| cwd? | string | (Optional) The current working directory. |
| excludes? | BettererOptionsExcludes | (Optional) A string or Regular Expression to match file paths that should be excluded from the BettererResultsSummary, or an array of them. Will be converted into BettererConfigExcludes. |
| filters? | BettererOptionsFilters | (Optional) A string or Regular Expression to match the names of relevant tests, or an array of them. Will be converted into BettererConfigFilters. |
| includes? | BettererOptionsIncludes | (Optional) A glob pattern to match file paths that should be included in the BettererResultsSummary, or an array of them. |
| resultsPath? | string | (Optional) The path to the results file. The resultsPath should be relative to the cwd. |