Arg

Index

Functions

• Flag
• Number
• Numbers
• Params
• String
• Strings
• flag
• number
• numbers
• params
• string
• strings

Functions

Flag

• Flag(description: string, config?: PartialConfig<Flag>): PropertyDecorator

• A property decorator for declaring a command line flag (boolean value).

Number

• Number(description: string, config?: PartialConfig<SingleOption<number>>): PropertyDecorator

• A property decorator for declaring a command line option with a numeric value.

Numbers

• Numbers(description: string, config?: PartialConfig<MultipleOption<number[]>>): PropertyDecorator

• A property decorator for declaring a command line option with multiple numeric values.

Params

• Params<T>(...config: MapParamConfig<T>): MethodDecorator

• A method decorator for declaring command line parameters (positional arguments).

  ---

  Type parameters

  • T: PrimitiveType[] = string[]

String

• String(description: string, config?: PartialConfig<SingleOption<string>>): PropertyDecorator

• A property decorator for declaring a command line option with a string value.

Strings

• Strings(description: string, config?: PartialConfig<MultipleOption<string[]>>): PropertyDecorator

• A property decorator for declaring a command line option with multiple string values.

flag

• flag(description: string, config?: PartialConfig<Flag>): boolean

• A property initializer for declaring a command line flag (boolean value).

number

• number<T>(description: string, config?: PartialConfig<SingleOption<number>>): T

• A property initializer for declaring a command line option with a numeric value.

  ---

  Type parameters

  • T: number = number

numbers

• numbers<T>(description: string, config?: PartialConfig<MultipleOption<number[]>>): T

• A property initializer for declaring a command line option with multiple numeric values.

  ---

  Type parameters

  • T: number[] = number[]

params

• params<T>(...config: MapParamConfig<T>): MapParamConfig<T>

• A property initializer for declaring command line parameters (positional arguments).

  ---

  Type parameters

  • T: PrimitiveType[] = string[]

string

• string<T>(description: string, config?: PartialConfig<SingleOption<string>>): T

• A property initializer for declaring a command line option with a string value.

  ---

  Type parameters

  • T: string = string

strings

• strings<T>(description: string, config?: PartialConfig<MultipleOption<string[]>>): T

• A property initializer for declaring a command line option with multiple string values.

  ---

  Type parameters

  • T: string[] = string[]