Interface to be implemented by all Command arguments.
type: ArgumentValueTypeName
Type of the argument value.
allowableValues: ReadonlyArray<ArgumentSingleValueType>
Optional list of values that the value must match. This is not supported for ArgumentValueTypeName.BOOLEAN.
isCaseInsensitive: boolean
Optional (default is false) for ArgumentValueTypeName.STRING when comparing a value against allowableValues.
minValueInclusive: number
Optional for ArgumentValueTypeName.INTEGER or ArgumentValueTypeName.NUMBER when validating a value.
maxValueInclusive: number
Optional for ArgumentValueTypeName.INTEGER or ArgumentValueTypeName.NUMBER when validating a value.
configurationKey: string
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 Argument.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.