Interface QuenchRegisterBatchOptions

Optional data used in the batch registration process

interface QuenchRegisterBatchOptions {
    displayName?: string;
    preSelected?: boolean;
    snapBaseDir?: string;
}

Properties

displayName?: string

A user-friendly name to show in the Quench UI and detailed results.

Defaults to the registration QuenchBatchKey

preSelected?: boolean

Whether this batch should be checked when added to the UI, and possibly run on startup if that setting is enabled.

true

snapBaseDir?: string

The directory in which snapshots for this batch are stored.

__snapshots__/${PACKAGE_NAME}, where PACKAGE_NAME is taken from the key parameter