x4js - v2.2.49
    Preparing search index...

    Interface InlineCompletionsProvider<T>

    interface InlineCompletionsProvider<
        T extends InlineCompletions = InlineCompletions,
    > {
        debounceDelayMs?: number;
        displayName?: string;
        excludesGroupIds?: string[];
        groupId?: string;
        onDidChangeInlineCompletions?: IEvent<void>;
        yieldsToGroupIds?: string[];
        disposeInlineCompletions(
            completions: T,
            reason: InlineCompletionsDisposeReason,
        ): void;
        handleEndOfLifetime?(
            completions: T,
            item: T["items"][number],
            reason: InlineCompletionEndOfLifeReason<T["items"][number]>,
            lifetimeSummary: LifetimeSummary,
        ): void;
        handleItemDidShow?(
            completions: T,
            item: T["items"][number],
            updatedInsertText: string,
            editDeltaInfo: EditDeltaInfo,
        ): void;
        handlePartialAccept?(
            completions: T,
            item: T["items"][number],
            acceptedCharacters: number,
            info: PartialAcceptInfo,
        ): void;
        handleRejection?(completions: T, item: T["items"][number]): void;
        provideInlineCompletions(
            model: ITextModel,
            position: Position,
            context: InlineCompletionContext,
            token: CancellationToken,
        ): ProviderResult<T>;
        toString?(): string;
    }

    Type Parameters

    Index
    debounceDelayMs? displayName? excludesGroupIds? groupId? onDidChangeInlineCompletions? yieldsToGroupIds?
    disposeInlineCompletions handleEndOfLifetime? handleItemDidShow? handlePartialAccept? handleRejection? provideInlineCompletions toString?
    debounceDelayMs?: number
    displayName?: string
    excludesGroupIds?: string[]
    groupId?: string

    Only used for yieldsToGroupIds. Multiple providers can have the same group id.

    onDidChangeInlineCompletions?: IEvent<void>
    yieldsToGroupIds?: string[]

    Returns a list of preferred provider groupIds. The current provider is only requested for completions if no provider with a preferred group id returned a result.

    • Will be called when an item is shown.

      Parameters

      • completions: T
      • item: T["items"][number]
      • updatedInsertText: string

        Is useful to understand bracket completion.

      • editDeltaInfo: EditDeltaInfo

      Returns void

    • Will be called when an item is partially accepted. TODO: also handle full acceptance here!

      Parameters

      • completions: T
      • item: T["items"][number]
      • acceptedCharacters: number

        Deprecated. Use info.acceptedCharacters instead.

      • info: PartialAcceptInfo

      Returns void

    Settings
    Member Visibility

    On This Page
    Properties
    Methods