Home > @rushstack/ts-command-line > IBaseCommandLineDefinitionWithArgument
IBaseCommandLineDefinitionWithArgument interface
The common base interface for parameter types that accept an argument.
Signature:
export interface IBaseCommandLineDefinitionWithArgument extends IBaseCommandLineDefinition
Extends: IBaseCommandLineDefinition
Remarks
An argument is an accompanying command-line token, such as "123" in the example "--max-count 123".
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | The name of the argument, which will be shown in the command-line help. | ||
() => Promise<ReadonlyArray<string> | ReadonlySet<string>> | (Optional) An optional callback that provides a list of custom choices for tab completion. |