Interface QuenchRegisterBatchOptions

Optional data used in the batch registration process

Hierarchy

  • QuenchRegisterBatchOptions

Properties

displayName? preSelected? snapBaseDir?

Properties

Optional displayName

displayName?: string

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

Default Value

Defaults to the registration QuenchBatchKey

Optional preSelected

preSelected?: boolean

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

Default Value

true

Optional snapBaseDir

snapBaseDir?: string

The directory in which snapshots for this batch are stored.

Default Value

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

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc