Rush Stack

IBaseCommandLineDefinition interface

For use with CommandLineParser, this interface represents a generic command-line parameter

Signature:

export interface IBaseCommandLineDefinition 

Property	Type	Description
description	string	Documentation for the parameter that will be shown when invoking the tool with “–help”
environmentVariable	string	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.
parameterLongName	string	The long name of the flag including double dashes, e.g. “–do-something”
parameterShortName	string	An optional short name for the flag including the dash, e.g. “-d”
required	boolean	If true, then an error occurs if the parameter was not included on the command-line.
undocumentedSynonyms	string[]	Specifies additional names for this parameter that are accepted but not displayed in the command line help.