languages

Interface InlineCompletion

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

Properties§

§readonly 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.

§readonly command?: Command

A command that is run upon acceptance of this item.

§readonly completeBracketPairs?: boolean

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

§readonly correlationId?: string

Used for telemetry.

§readonly gutterMenuLinkAction?: Command
§readonly hint?: InlineCompletionHint
§readonly insertText: 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.

§readonly isInlineEdit?: boolean
§readonly range?: IRange

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

§readonly showInlineEditMenu?: boolean
§readonly shownCommand?: Command

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

§readonly showRange?: IRange

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

§readonly uri?: UriComponents

The file for which the edit applies to.

§readonly warning?: InlineCompletionWarning