Class ArgumentParser<T>

Implements parsing of command-line arguments into option values.

Type Parameters

T extends Options = Options
The type of the option definitions

Index

Constructors

Properties

Methods

parse parseInto validate

Constructors

constructor

new ArgumentParser<T>(options, config?): ArgumentParser<T>
Creates an argument parser based on a set of option definitions.
Type Parameters
- T extends Readonly<Record<string, Option>> = Readonly<Record<string, Option>>
Parameters
- options: T
  The option definitions
- config: ValidatorConfig = {}
  The validator configuration
Returns ArgumentParser<T>
- Defined in packages/tsargp/lib/parser.ts:148

Properties

`Private` `Readonly` validator

validator: OptionValidator

Methods

parse

parse(cmdLine?, flags?): Promise<{
-readonly [key in string | number | symbol]: OptionDataType<T[key]>
}>
Parses command-line arguments into option values.
Parameters
- Optional cmdLine: CommandLine
  The command line or arguments
- Optional flags: ParsingFlags
  The parsing flags
Returns Promise<{
-readonly [key in string | number | symbol]: OptionDataType<T[key]>
}>
The options' values
- Defined in packages/tsargp/lib/parser.ts:169

parseInto

parseInto(values, cmdLine?, flags?): Promise<ParsingResult>
Parses command-line arguments into option values.
Parameters
- values: {
  -readonly [key in string | number | symbol]: OptionDataType<T[key]>
  }
  The options' values to parse into
- cmdLine: string | string[] = ...
  The command line or arguments
- Optional flags: ParsingFlags
  The parsing flags
Returns Promise<ParsingResult>
The parsing result
- Defined in packages/tsargp/lib/parser.ts:182

validate

validate(flags?): Promise<ValidationResult>
Validates the option definitions. This should only be called during development and testing, but skipped in production.
Parameters
- Optional flags: ValidationFlags
  The validation flags
Returns Promise<ValidationResult>
The validation result
- Defined in packages/tsargp/lib/parser.ts:159