Home > @rushstack/ts-command-line > CommandLineParameter
CommandLineParameter class
The base class for the various command-line parameter types.
Signature:
export declare abstract class CommandLineParameter
Remarks
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the CommandLineParameter class.
Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| description | string | Documentation for the parameter that will be shown when invoking the tool with “–help” | |
| environmentVariable | string | undefined | The name of an environment variable that the parameter value will be read from, if it was omitted from the command-line. An error will be reported if the environment value cannot be parsed. | |
| kind | CommandLineParameterKind | Indicates the type of parameter. | |
| longName | string | The long name of the flag including double dashes, e.g. “–do-something” | |
| required | boolean | If true, then an error occurs if the parameter was not included on the command-line. | |
| shortName | string | undefined | An optional short name for the flag including the dash, e.g. “-d” | |
| undocumentedSynonyms | string[] | undefined | Specifies additional names for this parameter that are accepted but not displayed in the command line help. |
Methods
| Method | Modifiers | Description |
|---|---|---|
| appendToArgList(argList) | Append the parsed values to the provided string array. | |
| reportInvalidData(data) | Internal usage only. Used to report unexpected output from the argparse library. | |
| validateDefaultValue(hasDefaultValue) |