Interface ArgsParserInterface

Readonlyconfig

Readonlyhelp

addAction

• addAction(config: ActionConfig): ArgsParserInterface

  Adds an action configuration to the parser.

  Parameters

  • config: ActionConfig

    The action configuration.

  Returns ArgsParserInterface

  The updated parser.

addArgument

• addArgument(config: ArgConfig): ArgsParserInterface

  Adds an argument configuration to the parser.

  Parameters

  • config: ArgConfig

    The argument configuration.

  Returns ArgsParserInterface

  The updated parser.

addHelpAction

• addHelpAction(name?: string, alias?: string): ArgsParserInterface

  Adds a help action to the parser.

  Parameters

  • Optionalname: string

    The name of the help action.
  • Optionalalias: string

    The alias of the help action.

  Returns ArgsParserInterface

  The updated parser.

addVersionAction

• addVersionAction(name?: string, alias?: string): ArgsParserInterface

  Adds a version action to the parser.

  Parameters

  • Optionalname: string

    The name of the version action.
  • Optionalalias: string

    The alias of the version action.

  Returns ArgsParserInterface

  The updated parser.

parse

• parse(argv: string[]): ParsedArgumentsCollectionInterface

  Parses the given argument string and returns a collection of parsed arguments.

  Parameters

  • argv: string[]

    The argument string.

  Returns ParsedArgumentsCollectionInterface

  A ParsedArgumentsCollection containing the parsed arguments.