Interface IInlineCompletionProvider<T>

The interface extensions should implement to provide inline completions.

interface IInlineCompletionProvider<T> {
    icon?: ILabIcon;
    identifier: string;
    name: string;
    schema?: IProperty;
    configure?(settings): void;
    fetch(request, context): Promise<IInlineCompletionList<T>>;
    stream?(token): AsyncGenerator<{
        response: T;
    }, any, unknown>;
}

Type Parameters

Hierarchy (view full)

Implemented by

Properties

icon? identifier name schema?

Methods

configure? fetch stream?

Properties

Optional Readonly icon

icon?: ILabIcon

The icon representing the provider in the user interface.

Readonly identifier

identifier: string

Unique identifier, cannot change on runtime.

The identifier is also added on data attribute of ghost text widget, allowing different providers to style the ghost text differently.

Readonly name

name: string

Name of the provider to be displayed in the user interface.

Optional Readonly schema

schema?: IProperty

Settings schema contributed by provider for user customization.

Methods

Optional configure

  • configure(settings): void

  • Optional method called when user changes settings.

    This is only called if schema for settings is present.

    Parameters

    Returns void

fetch

Optional stream

Settings

Member Visibility

Theme

On This Page

iconidentifiernameschemaconfigurefetchstream