property Argument.configurationKey

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.

Type

string

Usage

import type Argument from ".";