RoadmapShopEvents
Skip to main content

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

CommandLineStringParameter class

The data type returned by CommandLineParameterProvider.defineStringParameter() .

Signature:
export declare class CommandLineStringParameter extends CommandLineParameterWithArgument
Extends: [CommandLineParameterWithArgument](/pages/ts-command-line.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

PropertyModifiersTypeDescription
defaultValuestring | undefinedThe default value which will be used if the parameter is omitted from the command line.
kindCommandLineParameterKindIndicates the type of parameter.
valuestring | undefinedReturns the argument value for a string parameter that was parsed from the command line.

Methods

MethodModifiersDescription
appendToArgList(argList)Append the parsed values to the provided string array.