Interface InvalidArgument

Details of an invalid parsed argument.

interface InvalidArgument {
    argument?: Argument | ComplexOption;
    message?: string;
    name?: string;
    reason: InvalidArgumentReason;
    value?:
        | PopulatedArgumentValueType
        | PopulatedArgumentValues
        | (PopulatedArgumentValueType | PopulatedArgumentValues)[];
}

Index

Properties

argument? message? name? reason value?

Properties

`Optional` `Readonly`argument

argument?: Argument | ComplexOption

The Argument (if it was able to be populated)

`Optional` `Readonly`message

message?: string

An optional message providing detail about the validation failure. Populated when reason is InvalidArgumentReason.CUSTOM_VALIDATION.

`Optional` `Readonly`name

name?: string

The name of the argument specified (if it was able to be populated)

`Readonly`reason

reason: InvalidArgumentReason

A reason for the parsing error

`Optional` `Readonly`value

value?:
    | PopulatedArgumentValueType
    | PopulatedArgumentValues
    | (PopulatedArgumentValueType | PopulatedArgumentValues)[]

The argument value (if it was able to be populated).

NOTE: This value is unlikely to be valid as it is the cause of the invalid argument error.