Interface ComplexOption

Optional configuration key to use for the argument. Must consist of alphanumeric non-whitespace uppercase ASCII or _ characters. Must not start with a digit.

If not specified a default configuration key is determined as follows: The SubCommandArgument.name is capitalized and any - characters are replaced with _ characters. If the result starts with a digit, it is prefixed with _. Some examples:

• name: FooBar => configuration key: FOOBAR
• name: Hello-World- => configuration key: HELLO_WORLD_
• name: 3 => configuration key: _3

NOTE: Regardless of whether a configurationKey is specified, or the default is relied upon, it will only be used if the parent Command has specified Command.enableConfiguration as true.

Optional description of the argument.

If this is true the option can be specified multiple times and all values will be returned in an array matching the order provided.

NOTE: If isOptional is false, at least one instance of the option must be specified.

Optional (default is false) for ArgumentValueTypeName.STRING when comparing a value against allowableValues.

If this is true the option does not need to be specified nor have a default value.

Optional for ArgumentValueTypeName.INTEGER or ArgumentValueTypeName.NUMBER when validating a value.

Optional for ArgumentValueTypeName.INTEGER or ArgumentValueTypeName.NUMBER when validating a value.

Name of the argument.

Must consist of alphanumeric non-whitespace ASCII or _ and - characters. Cannot start with -.

Optional short alias for the option.

Must consist of a single alphanumeric non-whitespace ASCII character.

Optional custom validation function invoked after all built-in validation has passed. Receives the validated and type-converted value.

Return undefined if the value is valid, or a string describing the validation error. The error string is associated with InvalidArgumentReason.CUSTOM_VALIDATION.

Example: ensure array values are unique:

validate: (value) => {
  const arr = value as string[];
  return new Set(arr).size !== arr.length
    ? "values must be unique"
    : undefined;
}
Copy