Interface ICompletionSuggestion

A completion suggestion.

It will be injected with additional properties by the parser:

type - 'parameter'
synopsis - the option synopsis, if any
displayName - the supplied option name

We recommend also extending the Suggestion type from @withfig/autocomplete-types.

interface ICompletionSuggestion {
name: string;
}

Index

Properties

Properties

name

name: string

The suggestion name (or the value used for traditional shell completion).