Interface SubCommandArgument

Optional list of values that the value must match. This is not supported for ArgumentValueTypeName.BOOLEAN.

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 (default is false) for ArgumentValueTypeName.STRING when comparing a value against allowableValues.

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

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

Type of the argument value.

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