Options
All
  • Public
  • Public/Protected
  • All
Menu

Class InlineCompletionItem

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

see

InlineCompletionItemProvider.provideInlineCompletionItems

Hierarchy

  • InlineCompletionItem

Index

Constructors(1)

Properties(4)

Constructors(1)

constructor

  • Creates a new inline completion item.

    Parameters

    • insertText: string | SnippetString

      The text to replace the range with.

    • Optional range: Range

      The range to replace. If not set, the word at the requested position will be used.

    • Optional command: Command

      An optional Command that is executed after inserting this completion.

    Returns InlineCompletionItem

Properties(4)

insertText

insertText: string | SnippetString

The text to replace the range with. Must be set. Is used both for the preview and the accept operation.

Optional filterText

filterText: string

A text that is used to decide if this inline completion should be shown. When falsy the InlineCompletionItem.insertText is used.

An inline completion is shown if the text to replace is a prefix of the filter text.

Optional range

range: Range

The range to replace. Must begin and end on the same line.

Prefer replacements over insertions to provide a better experience when the user deletes typed text.

Optional command

command: Command

An optional Command that is executed after inserting this completion.

Generated by TypeDoc. Maintained by 紫升

Links: 搜外友链, 69中文网