Interface CompletionProvider

Language-specific service for handling completion requests.

interface CompletionProvider {
    completionOptions?: CompletionProviderOptions;
    getCompletion(
        document: LangiumDocument,
        params: CompletionParams,
        cancelToken?: Cancellation.CancellationToken,
    ): MaybePromise<undefined | CompletionList>;
}

Implemented by

DefaultCompletionProvider

Index

Properties

completionOptions?

Methods

Properties

`Optional` `Readonly`completionOptions

completionOptions?: CompletionProviderOptions

Contains the completion options for this completion provider.

If multiple languages return different options, they are merged before being sent to the language client.

Methods

getCompletion

getCompletion(
    document: LangiumDocument,
    params: CompletionParams,
    cancelToken?: Cancellation.CancellationToken,
): MaybePromise<undefined | CompletionList>
Handle a completion request.
Parameters
- document: LangiumDocument
  the document for which the completion request was triggered
- params: CompletionParams
  the completion parameters
- OptionalcancelToken: Cancellation.CancellationToken
  a token that can be used to cancel the request
Returns MaybePromise<undefined | CompletionList>
Throws
OperationCancelled if cancellation is detected during execution

Throws
ResponseError if an error is detected that should be sent as response to the client
- Defined in packages/langium/src/lsp/completion/completion-provider.ts:117