Home > @rushstack/ts-command-line > CommandLineStringParameter

CommandLineStringParameter class

The data type returned by CommandLineParameterProvider.defineStringParameter().

Signature:

export declare class CommandLineStringParameter extends CommandLineParameterWithArgument 

Extends: CommandLineParameterWithArgument

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 CommandLineStringParameter class.

Properties

Property	Modifiers	Type	Description
defaultValue	readonly	string | undefined	The default value which will be used if the parameter is omitted from the command line.
kind	readonly	CommandLineParameterKind.String	Indicates the type of parameter.
value	readonly	string | undefined	Returns the argument value for a string parameter that was parsed from the command line.

Methods

Method	Modifiers	Description
appendToArgList(argList)		Append the parsed values to the provided string array.