Interface ParseResult

A container holding the result of a command clause parsing operation.

interface ParseResult {
    command: Command;
    groupCommand?: GroupCommand;
    invalidArguments: readonly InvalidArgument[];
    populatedArgumentValues:
        | PopulatedArgumentSingleValueType
        | PopulatedArgumentValues;
    unusedArgs: readonly string[];
}

Index

Properties

command groupCommand? invalidArguments populatedArgumentValues unusedArgs

Properties

`Readonly`command

command: Command

The Command to execute if the parse result is valid (i.e. invalidArguments is empty).

`Optional` `Readonly`groupCommand

groupCommand?: GroupCommand

Optional parent GroupCommand if the parsed command was a member SubCommand,

`Readonly`invalidArguments

invalidArguments: readonly InvalidArgument[]

Any arguments which were invalid.

`Readonly`populatedArgumentValues

populatedArgumentValues:
| PopulatedArgumentSingleValueType
| PopulatedArgumentValues

The argument values populated from the command line args. If the parse result is valid (i.e. invalidArguments is empty), this can be used to execute the specified command. PopulatedArgumentSingleValueType is for GlobalCommand values, PopulatedArgumentValues is for SubCommand values.

`Readonly`unusedArgs

unusedArgs: readonly string[]

Any arguments which were unused in the parsing operation.