Class Argument

constructor

• new Argument(arg: string, description?: string): Argument

  Initialize a new command argument with the given name and description. The default is that the argument is required, and you can explicitly indicate this with <> around the name. Put [] around the name for an optional argument.

  Parameters

  • arg: string
  • Optionaldescription: string

  Returns Argument

OptionalargChoices

OptionaldefaultValue

OptionaldefaultValueDescription

description

OptionalparseArg

required

variadic

argOptional

• argOptional(): this

  Make argument optional.

  Returns this

argParser

• argParser<T>(fn: (value: string, previous: T) => T): this

  Set the custom handler for processing CLI command arguments into argument values.

  Type Parameters

  • T

  Parameters

  • fn: (value: string, previous: T) => T

  Returns this

argRequired

• argRequired(): this

  Make argument required.

  Returns this

choices

• choices(values: readonly string[]): this

  Only allow argument value to be one of choices.

  Parameters

  • values: readonly string[]

  Returns this

default

• default(value: unknown, description?: string): this

  Set the default value, and optionally supply the description to be displayed in the help.

  Parameters

  • value: unknown
  • Optionaldescription: string

  Returns this

name

• name(): string

  Return argument name.

  Returns string