Class ArgsParser

constructor

• new ArgsParser(config: ArgParserConfig, args?: ArgConfig[]): ArgsParser

  Constructs an instance of ArgsParser with the provided argument configurations.

  Parameters

  • config: ArgParserConfig

    Configuration options for the parser.
  • args: ArgConfig[] = []

    An array of argument configurations.

  Returns ArgsParser

Readonlyconfig

help

• get help(): string

  Retrieves the help message.

  Returns string

addAction

• addAction(config: ActionConfig): ArgsParser

  Adds an action configuration to the parser.

  Parameters

  • config: ActionConfig

    The action configuration.

  Returns ArgsParser

  The updated parser.

addArgument

• addArgument(config: ArgConfig): ArgsParser

  Adds a new argument configuration to the parser.

  Parameters

  • config: ArgConfig

    The argument configuration.

  Returns ArgsParser

  The instance of ArgsParser for chaining.

  Example

  const parser = new ArgsParser();
  parser.addArgument({
    name: '--flag',
    alias: '-f',
    type: 'boolean',
    const: true,
    default: false,
  });
  Copy

addHelpAction

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

  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 ArgsParser

  The updated parser.

addVersionAction

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

  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 ArgsParser

  The updated parser.

parse

• parse(argv: string[]): ParsedArgumentsCollection

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

  Parameters

  • argv: string[]

    The argument string.

  Returns ParsedArgumentsCollection

  A ParsedArgumentsCollection containing the parsed arguments.

  Example

  const parser = new ArgsParser([
     {
         name: 'action',
         description: 'Action to perform',
         type: 'string',
     },
     {
         name: '--flag',
         description: 'Flag',
         alias: '-f',
         type: 'boolean',
         const: true,
         default: false,
     },
     {
         name: '--values',
         description: 'Values',
         alias: '-v',
         type: 'string',
         nargs: '*',
         default: [],
     }
  ]);
  
  const argv = ['make', '--flag', '-v', 'a', 'b', 'c'];
  const parsedArgs = parser.parse(argv);
  
  console.log(parsedArgs.positional); // { action: 'make' }
  console.log(parsedArgs.optional); // { flag: true, values: ['a', 'b', 'c'] }
  console.log(parsedArgs.get('--values')); // ['a', 'b', 'c']
  Copy