The help text to be displayed to the user when --help is passed.
Maps a given value to the option type. The map type may be a TypeScript enum. In that case, when generating an error message for a mismatched key, the numeric keys will not be listed.
The option name.
The parameter type, used to convert user configuration values into the expected type. If not set, the type will be a string.
Optional
configIf set, this option will be omitted from --help
, and attempting to specify it on the command
line will produce an error.
Optional
mapOptional override for the error reported when an invalid key is provided.
Generated using TypeDoc
Unlike the rest of the option types, there is no sensible generic default for mapped option types. The default value for a mapped type must be specified.