Home > @rushstack/ts-command-line > IBaseCommandLineDefinitionWithArgument > getCompletionsAsync

IBaseCommandLineDefinitionWithArgument.getCompletionsAsync property

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

Signature:

getCompletionsAsync?: () => Promise<ReadonlyArray<string> | ReadonlySet<string>>;

Remarks

This option is only used when ICommandLineParserOptions.enableTabCompletionAction is enabled.