RoadmapShopEvents
Skip to main content

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](/pages/ts-command-line.ibasecommandlinedefinition)

Remarks

An argument is an accompanying command-line token, such as "123" in the example "--max-count 123".

Properties

PropertyTypeDescription
argumentNamestringThe name of the argument, which will be shown in the command-line help.
completions?() => Promise<string[]>(Optional) An optional callback that provides a list of custom choices for tab completion.