Optional
additionalAn optional array of additional text edits that are applied when selecting this completion. Edits must not overlap with the main edit nor with themselves.
Optional
commandA command that should be run upon acceptance of this item.
Optional
commitAn 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.
Optional
detailA human-readable string with additional information about this item, like type or symbol information.
Optional
documentationA human-readable string that represents a doc-comment.
Optional
filterA string that should be used when filtering a set of
completion items. When falsy
the label
is used.
A string or snippet that should be inserted in a document when selecting this completion.
Optional
insertAdditional rules (as bitmask) that should be applied when inserting this completion.
The kind of this completion item. Based on the kind an icon is chosen by the editor.
The label of this completion item. By default this is also the text that is inserted when selecting this completion.
Optional
preselectSelect 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.
A range of text that should be replaced by this completion item.
Defaults to a range from the start of the TextDocument.getWordRangeAtPosition current word to the current position.
Note: The range must be a Range.isSingleLine single line and it must Range.contains contain the position at which completion has been requested.
Optional
sortA string that should be used when comparing this item
with other items. When falsy
the label
is used.
Optional
tagsA modifier to the kind
which affect how the item
is rendered, e.g. Deprecated is rendered with a strikeout
A completion item represents a text snippet that is proposed to complete text that is being typed.