Interface BooleanDeclarationOption

interface BooleanDeclarationOption {
    help: string;
    name: string;
    type: Boolean;
    configFileOnly?: boolean;
    defaultValue?: boolean;
}

Hierarchy (view full)

Properties

help name type configFileOnly? defaultValue?

Properties

help

help: string

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

name

name: string

The option name.

type

type: Boolean

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

Optional configFileOnly

configFileOnly?: boolean

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

Optional defaultValue

defaultValue?: boolean

If not specified defaults to false.

Settings

Member Visibility

Theme

On This Page

helpnametypeconfigFileOnlydefaultValue