Interface DeclarationOptionBase

interface DeclarationOptionBase {
    help: string;
    name: string;
    configFileOnly?: boolean;
    type?: ParameterType;
}

Hierarchy (view full)

Properties

help: string

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

name: string

The option name.

configFileOnly?: boolean

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

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

Generated using TypeDoc