CompletionItem

A completion item represents a text snippet that is proposed to complete text that is being typed.

It is sufficient to create a completion item from just a label. In that case the completion item will replace the word until the cursor with the given label or insertText. Otherwise the given CompletionItem.textEdit is used.

When selecting a completion item in the editor its defined or synthesized text edit will be applied to all cursors/selections whereas additionalTextEdits will be applied as provided.

See also

Constructors

Link copied to clipboard
constructor(label: JsAny, kind: CompletionItemKind = definedExternally)

Creates a new completion item.

Properties

Link copied to clipboard

An optional array of additional text edits that are applied when selecting this completion. Edits must not overlap with the main CompletionItem.textEdit nor with themselves.

Link copied to clipboard

An optional Command that is executed after inserting this completion. Note that additional modifications to the current document should be described with the additionalTextEdits-property.

Link copied to clipboard

An optional set of characters that when pressed while this completion is active will accept it first and then type that character. Note that all commit characters should have length=1 and that superfluous characters will be ignored.

Link copied to clipboard

A human-readable string with additional information about this item, like type or symbol information.

Link copied to clipboard

A human-readable string that represents a doc-comment.

Link copied to clipboard

A string that should be used when filtering a set of completion items. When falsy the label is used.

Link copied to clipboard

A string or snippet that should be inserted in a document when selecting this completion. When falsy the label is used.

Link copied to clipboard

Keep whitespace of the insertText as is. By default, the editor adjusts leading whitespace of new lines so that they match the indentation of the line for which the item is accepted - setting this to true will prevent that.

Link copied to clipboard

The kind of this completion item. Based on the kind an icon is chosen by the editor.

Link copied to clipboard

The label of this completion item. By default this is also the text that is inserted when selecting this completion.

Link copied to clipboard

Select this item when showing. Note that only one completion item can be selected and that the editor decides which item that is. The rule is that the first item of those that match best is selected.

Link copied to clipboard

A string that should be used when comparing this item with other items. When falsy the label is used.

Link copied to clipboard

Tags for this completion item.