Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ArgumentParser

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

addArgument

  • Parameters

    Returns void

addArgumentGroup

addMutuallyExclusiveGroup

  • addMutuallyExclusiveGroup(options?: undefined | object): ArgumentGroup

addSubparsers

  • Parameters

    Returns SubParser

convertArgLineToArg

  • convertArgLineToArg(argLine: string): string[]

  • Parameters

    • argLine: string

    Returns string[]

error

  • error(err: string | Error): void

  • Parameters

    • err: string | Error

    Returns void

exit

  • exit(status: number, message: string): void

  • Parameters

    • status: number
    • message: string

    Returns void

formatHelp

  • formatHelp(): string

  • Returns string

formatUsage

  • formatUsage(): string

  • Returns string

getDefault

  • getDefault(dest: string): any

  • Parameters

    • dest: string

    Returns any

parseArgs

  • parseArgs(args?: string[], ns?: Namespace | object): any

  • Parameters

    • Optional args: string[]
    • Optional ns: Namespace | object

    Returns any

parseKnownArgs

  • parseKnownArgs(args?: string[], ns?: Namespace | object): any[]

  • Parameters

    • Optional args: string[]
    • Optional ns: Namespace | object

    Returns any[]

printHelp

  • printHelp(): void

  • Returns void

printUsage

  • printUsage(): void

  • Returns void

setDefaults

  • setDefaults(options?: undefined | __type): void

  • Parameters

    • Optional options: undefined | __type

    Returns void

Generated using TypeDoc