Rush StackShopBlogEvents
Skip to main content

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

CommandLineStringListParameter class​

The data type returned by CommandLineParameterProvider.defineStringListParameter().

Signature:

export declare class CommandLineStringListParameter 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 CommandLineStringListParameter class.

Properties​

Property

Modifiers

Type

Description

kind

readonly

CommandLineParameterKind.StringList

Indicates the type of parameter.

values

readonly

ReadonlyArray<string>

Returns the string arguments for a string list parameter that was parsed from the command line.

Methods​

Method

Modifiers

Description

appendToArgList(argList)

Append the parsed values to the provided string array.