Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CompletionEntry

Hierarchy

  • CompletionEntry

Index

Properties

Optional data

A property to be sent back to TS Server in the CompletionDetailsRequest, along with name, that allows TS Server to look up the symbol represented by the completion item, disambiguating items with the same name. Currently only defined for auto-import completions, but the type is unknown in the protocol, so it can be changed as needed to support other kinds of completions. The presence of this property should generally not be used to assume that this completion entry is an auto-import.

Optional hasAction

hasAction: true

Optional insertText

insertText: string

Optional isFromUncheckedFile

isFromUncheckedFile: true

Optional isImportStatementCompletion

isImportStatementCompletion: true

Optional isPackageJsonImport

isPackageJsonImport: true

Optional isRecommended

isRecommended: true

Optional isSnippet

isSnippet: true

kind

Optional kindModifiers

kindModifiers: string

name

name: string

Optional replacementSpan

replacementSpan: TextSpan

An optional span that indicates the text to be replaced by this completion item. If present, this span should be used instead of the default one. It will be set if the required span differs from the one generated by the default replacement behavior.

sortText

sortText: string

Optional source

source: string

Optional sourceDisplay

sourceDisplay: SymbolDisplayPart[]

Generated using TypeDoc