Interface SignatureHelpProvider

Language-specific service for handling signature help requests.

interface SignatureHelpProvider {
get signatureHelpOptions(): SignatureHelpOptions;
provideSignatureHelp(document: LangiumDocument<AstNode>, params: SignatureHelpParams, cancelToken?: CancellationToken): MaybePromise<undefined | SignatureHelp>;
}

Implemented by

AbstractSignatureHelpProvider

Index

Accessors

signatureHelpOptions

Methods

provideSignatureHelp

Accessors

signatureHelpOptions

get signatureHelpOptions(): SignatureHelpOptions
Options that determine the server capabilities for a signature help request. It contains the list of triggering characters.

Returns SignatureHelpOptions
- Defined in packages/langium/src/lsp/signature-help-provider.ts:25

Methods

provideSignatureHelp

provideSignatureHelp(document, params, cancelToken?): MaybePromise<undefined | SignatureHelp>
Handles a signature help request
Parameters
- document: LangiumDocument<AstNode>
- params: SignatureHelpParams
- OptionalcancelToken: CancellationToken
Returns MaybePromise<undefined | SignatureHelp>
- Defined in packages/langium/src/lsp/signature-help-provider.ts:21