Interface MixedDeclarationOption

interface MixedDeclarationOption {
    help: string;
    name: string;
    type: Mixed;
    configFileOnly?: boolean;
    defaultValue?: unknown;
    validate?: ((value) => void);
}

Hierarchy (view full)

Properties

help: string

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

name: string

The option name.

type: Mixed

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

configFileOnly?: boolean

If set, this option will be omitted from --help, and attempting to specify it on the command line will produce an error.

defaultValue?: unknown

If not specified defaults to undefined.

validate?: ((value) => 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.

Type declaration

    • (value): 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