Interface ObjectDeclarationOption

Hierarchy

Properties

help: string

The help text to be displayed to the user when --help is passed.

name: string

The option name.

type: Object

The parameter type, used to convert user configuration values into the expected type. If not set, the type will be a string.

defaultValue?: unknown

If not specified defaults to undefined.

validate?: ((value: unknown) => void)

Type declaration

    • (value: unknown): void
    • An optional validation function that validates a potential value of this option. The function must throw an Error if the validation fails and should do nothing otherwise.

      Parameters

      • value: unknown

      Returns void

Generated using TypeDoc