Interface InlineCompletion

interface InlineCompletion {
    additionalTextEdits?: ISingleEditOperation[];
    command?: Command;
    completeBracketPairs?: boolean;
    correlationId?: string;
    gutterMenuLinkAction?: Command;
    hint?: InlineCompletionHint;
    insertText: undefined | string | {
        snippet: string;
    };
    isInlineEdit?: boolean;
    range?: IRange;
    showInlineEditMenu?: boolean;
    showRange?: IRange;
    shownCommand?: Command;
    uri?: UriComponents;
    warning?: InlineCompletionWarning;
}

Properties

additionalTextEdits? command? completeBracketPairs? correlationId? gutterMenuLinkAction? hint? insertText isInlineEdit? range? showInlineEditMenu? showRange? shownCommand? uri? warning?

Properties

Optional Readonly additionalTextEdits

additionalTextEdits?: ISingleEditOperation[]

An optional array of additional text edits that are applied when selecting this completion. Edits must not overlap with the main edit nor with themselves. Refers to the current document or uri if provided.

Optional Readonly command

command?: Command

A command that is run upon acceptance of this item.

Optional Readonly completeBracketPairs

completeBracketPairs?: boolean

If set to true, unopened closing brackets are removed and unclosed opening brackets are closed. Defaults to false.

Optional Readonly correlationId

correlationId?: string

Used for telemetry.

Optional Readonly gutterMenuLinkAction

gutterMenuLinkAction?: Command

Optional Readonly hint

hint?: InlineCompletionHint

Readonly insertText

insertText: undefined | string | {
    snippet: string;
}

The text to insert. If the text contains a line break, the range must end at the end of a line. If existing text should be replaced, the existing text must be a prefix of the text to insert.

The text can also be a snippet. In that case, a preview with default parameters is shown. When accepting the suggestion, the full snippet is inserted.

Type declaration

  • snippet: string

Optional Readonly isInlineEdit

isInlineEdit?: boolean

Optional Readonly range

range?: IRange

The range to replace. Must begin and end on the same line. Refers to the current document or uri if provided.

Optional Readonly showInlineEditMenu

showInlineEditMenu?: boolean

Optional Readonly showRange

showRange?: IRange

Only show the inline suggestion when the cursor is in the showRange.

Optional Readonly shownCommand

shownCommand?: Command

Is called the first time an inline completion is shown. @deprecated. Use onDidShow of the provider instead.

Optional Readonly uri

uri?: UriComponents

The file for which the edit applies to.

Optional Readonly warning

warning?: InlineCompletionWarning

Settings

Member Visibility

Theme

On This Page

additionalTextEditscommandcompleteBracketPairscorrelationIdgutterMenuLinkActionhintinsertTextisInlineEditrangeshowInlineEditMenushowRangeshownCommanduriwarning