Class ArgParser

constructor

• new ArgParser(name, desc, argList?, examples?): ArgParser

• Create a unix-like argument parser to extract flags from the argument list. Can also create help messages.

  Parameters

  • name: string

    Script name
  • desc: string

    Help description
  • argList: (ArgParser | Arg<any>)[] = []

    Array of CLI arguments
  • examples: string[] = []

    Additional examples to display

  Returns ArgParser

ReadonlyargList

args

commands

defaults

Readonlydesc

Readonlyexamples

flags

Readonlyname

help

• help(opts?): string

• Create help message from the provided description & argument list.

  Parameters

  • opts: {
        command?: string;
        message?: string;
    } = {}

    Help options: command - display a commands help, message - override help description

    • Optionalcommand?: string

    • Optionalmessage?: string

  Returns string

  Help message

parse

• parse(args): any

• Parse an array into an arguments dictionary using the configuration.

  Parameters

  • args: string[]

    Array of arguments to be parsed

  Returns any

  Dictionary of arguments with defaults applied