ParserOptions <O, P>

Hierarchy

• ParserSettings
  • ParserOptions

Index

Properties

• commands
• loose
• options
• params
• unknown
• variadic

Properties

optionalcommands

commands?: string[] | CommandChecker

List of valid commands. Sub-commands should be denoted with ":".

optionalloose

loose?: boolean

Inherited from ParserSettings.loose

Enable loose mode parsing.

options

options: MapOptionConfig<O>

Mapping of options to their type and configurations.

optionalparams

params?: MapParamConfig<P>

List of param configurations (in order).

optionalunknown

unknown?: boolean

Inherited from ParserSettings.unknown

Allow unknown options to be passed. Will be placed in a special unknown object.

optionalvariadic

variadic?: boolean

Inherited from ParserSettings.variadic

Allow variadic params to be passed. Will be accumlated after configured params.