RoadmapShopEvents
Skip to main content

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

ICommandLineStringDefinition interface

For use with CommandLineParameterProvider.defineStringParameter(), this interface defines a command line parameter whose argument is a string value.

Signature:

export interface ICommandLineStringDefinition extends IBaseCommandLineDefinitionWithArgument 

Extends: IBaseCommandLineDefinitionWithArgument

Properties

PropertyModifiersTypeDescription
argumentNamestring

The name of the argument, which will be shown in the command-line help.

(Inherited from IBaseCommandLineDefinitionWithArgument)

completions?() => Promise<string[]>

(Optional) An optional callback that provides a list of custom choices for tab completion.

(Inherited from IBaseCommandLineDefinitionWithArgument)

defaultValue?string(Optional) The default value which will be used if the parameter is omitted from the command line.
descriptionstring

Documentation for the parameter that will be shown when invoking the tool with "--help"

(Inherited from IBaseCommandLineDefinition)

environmentVariable?string

(Optional) 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.

(Inherited from IBaseCommandLineDefinition)

parameterGroup?string | typeof SCOPING_PARAMETER_GROUP

(Optional) An optional parameter group name, shown when invoking the tool with "--help"

(Inherited from IBaseCommandLineDefinition)

parameterLongNamestring

The long name of the flag including double dashes, e.g. "--do-something"

(Inherited from IBaseCommandLineDefinition)

parameterScope?string

(Optional) An optional parameter scope name, used to add a scope-prefixed parameter synonym, e.g. "--scope:do-something". Scopes provide additional flexibility for parameters in conflict resolution since when a scope is specified, parameters that have conflicting long names will be defined using only the scope-prefixed name.

(Inherited from IBaseCommandLineDefinition)

parameterShortName?string

(Optional) An optional short name for the flag including the dash, e.g. "-d"

(Inherited from IBaseCommandLineDefinition)

required?boolean

(Optional) If true, then an error occurs if the parameter was not included on the command-line.

(Inherited from IBaseCommandLineDefinition)

undocumentedSynonyms?string[]

(Optional) Specifies additional names for this parameter that are accepted but not displayed in the command line help.

(Inherited from IBaseCommandLineDefinition)