kotlin-typescript/typescript/CompletionEntry

CompletionEntry

sealed external interface CompletionEntry(source)

Properties

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.

filterText

abstract var filterText: String?

hasAction

abstract var hasAction: Boolean?

insertText

abstract var insertText: String?

isFromUncheckedFile

abstract var isFromUncheckedFile: Boolean?

isImportStatementCompletion

abstract var isImportStatementCompletion: Boolean?

isPackageJsonImport

abstract var isPackageJsonImport: Boolean?

isRecommended

abstract var isRecommended: Boolean?

isSnippet

abstract var isSnippet: Boolean?

kind

abstract var kind: ScriptElementKind

kindModifiers

abstract var kindModifiers: String?

labelDetails

abstract var labelDetails: CompletionEntryLabelDetails?

name

abstract var name: String

replacementSpan

abstract var 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

abstract var sortText: String

source

abstract var source: String?

sourceDisplay

abstract var sourceDisplay: ReadonlyArray<SymbolDisplayPart>?

symbol

abstract var symbol: Symbol?

For API purposes. Included for non-string completions only when includeSymbol: true option is passed to getCompletionsAtPosition.