Interface ILoadConfigurationOptions

Options for loadConfiguration

interface ILoadConfigurationOptions {
    file?: string | false;
    profiles?: string[];
    provided?: string | string[] | Partial<IConfiguration>;
}

Properties

file?: string | false

Path to load configuration file from, or false to skip

Default

cucumber.(json|yaml|yml|js|cjs|mjs)

profiles?: string[]

Zero or more profile names from which to source configuration in the file

Remarks

If omitted or empty, the default profile will be used.

provided?: string | string[] | Partial<IConfiguration>

Ad-hoc configuration options to be merged over the top of whatever is loaded from the configuration file/profiles

Example

{
failFast: true,
parallel: 2
}

Example

["--fail-fast", "--parallel", "2"]

Example

"--fail-fast --parallel 2"

Remarks

This can also be provided as an array or single string of argv-style arguments.

Generated using TypeDoc