Interface IInlineItemAlpha

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

interface IInlineItem {
    filterText?: string;
    insertText: string;
    isIncomplete?: boolean;
    lastStreamed?: string;
    provider: IInlineCompletionProviderInfo;
    stream: ISignal<IInlineItem, StraemEvent>;
    streaming: boolean;
    token?: string;
}

Hierarchy (view full)

Properties

filterText? insertText isIncomplete? lastStreamed? provider stream streaming token?

Properties

Optional filterText

filterText?: string

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

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

insertText

insertText: string

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

Optional isIncomplete

isIncomplete?: boolean

Whether generation of insertText is still ongoing. If your provider supports streaming, you can set this to true, which will result in the provider's stream() method being called with token which has to be set for incomplete completions.

Optional lastStreamed

lastStreamed?: string

Most recent streamed token if any.

provider

provider: IInlineCompletionProviderInfo

The source provider information.

stream

stream: ISignal<IInlineItem, StraemEvent>

Signal emitted when the item gets updated by streaming.

streaming

streaming: boolean

Whether streaming is in progress.

Optional token

token?: string

Settings

Member Visibility

Theme

On This Page

filterTextinsertTextisIncompletelastStreamedproviderstreamstreamingtoken