Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CompletionItem

A completion item is a suggestion to complete text that the user has typed.

see

{@link CompletionItemProvider#provideCompletionItems}

Hierarchy

  • CompletionItem

Index

Properties

Optional description

description: undefined | string

The description of this completion item, which is rendered less prominently but still alongside the {@link CompletionItem#label}.

Optional insertText

insertText: undefined | string

A string to insert in a document when the user selects this completion. When not set, the {@link CompletionItem#label} is used.

label

label: string

The label of this completion item, which is rendered prominently. If no {@link CompletionItem#insertText} is specified, the label is the text inserted when the user selects this completion.

Generated using TypeDoc