Interface QuenchRunBatchOptions

Options affecting the running of batches

interface QuenchRunBatchOptions {
    json?: boolean | QuenchJsonReportOptions;
    preSelectedOnly?: boolean;
    updateSnapshots?: null | boolean;
}

Index

Properties

json? preSelectedOnly? updateSnapshots?

Properties

`Optional`json

json?: boolean | QuenchJsonReportOptions

Generate a JSON report.

If false, a JSON report will be generated and made available in quench.reports, as well as through the hookEvents!quenchReports hook.
If true, a JSON report will be generated as above, and also be uploaded to the server as Data/quench-report.json, overwriting any existing file. Option defaults can be found in QuenchJsonReportOptions.
If an object is provided, additional options can be set.

Default Value

false

`Optional`preSelectedOnly

preSelectedOnly?: boolean

Whether only batches registered with QuenchRegisterBatchOptions.preSelected set to true should be run.

Default Value

false

`Optional`updateSnapshots

updateSnapshots?: null | boolean

Whether snapshots generated in this run should be saved

Default Value

null