Interface IProviderReconciliator

interface IProviderReconciliator {
    fetch(
        request: CompletionHandler.IRequest,
        trigger?: CompletionTriggerKind,
    ): Promise<null | ICompletionItemsReply<ICompletionItem>>;
    fetchInline(
        request: CompletionHandler.IRequest,
        trigger?: InlineCompletionTriggerKind,
        isMiddleOfLine?: boolean,
    ): Promise<null | IInlineCompletionList<IInlineItem>>[];
    shouldShowContinuousHint(
        completerIsVisible: boolean,
        changed: SourceChange,
    ): Promise<boolean>;
}

Methods

fetch(
request: CompletionHandler.IRequest,
trigger?: CompletionTriggerKind,
): Promise<null | ICompletionItemsReply<ICompletionItem>>
Fetch response from multiple providers, If a provider can not return the response for a completer request before timeout, the result of this provider will be ignore.
Parameters
- request: CompletionHandler.IRequest
  The completion request.
- Optionaltrigger: CompletionTriggerKind
  Who triggered the request (optional).
Returns Promise<null | ICompletionItemsReply<ICompletionItem>>
- Defined in packages/completer/src/tokens.ts:515

fetchInline(
    request: CompletionHandler.IRequest,
    trigger?: InlineCompletionTriggerKind,
    isMiddleOfLine?: boolean,
): Promise<null | IInlineCompletionList<IInlineItem>>[]
Returns a list of promises to enable showing results from the provider which resolved fastest, even if other providers are still generating. The result may be null if the request timed out.
Parameters
- request: CompletionHandler.IRequest
- Optionaltrigger: InlineCompletionTriggerKind
- OptionalisMiddleOfLine: boolean
Returns Promise<null | IInlineCompletionList<IInlineItem>>[]
- Defined in packages/completer/src/tokens.ts:526

shouldShowContinuousHint(
completerIsVisible: boolean,
changed: SourceChange,
): Promise<boolean>
Check if completer should make request to fetch completion responses on user typing. If the provider with highest rank does not have shouldShowContinuousHint method, a default one will be used.
Parameters
- completerIsVisible: boolean
  The visible status of completer widget.
- changed: SourceChange
  CodeMirror changed argument.
Returns Promise<boolean>
- Defined in packages/completer/src/tokens.ts:540