RoadmapShopEvents
Skip to main content

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

CommandLineRemainder class

The data type returned by CommandLineParameterProvider.defineCommandLineRemainder() .

Signature:
export declare class CommandLineRemainder

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

Properties

PropertyModifiersTypeDescription
descriptionstringDocumentation for the parameter that will be shown when invoking the tool with "--help"
valuesReadonlyArray<string>Returns any remaining command line arguments after the recognized portion that was parsed from the command line.

Methods

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