Class AbstractSignatureHelpProvider`Abstract`

Language-specific service for handling signature help requests.

Implements

SignatureHelpProvider

Index

Constructors

Accessors

signatureHelpOptions

Methods

getSignatureFromElement provideSignatureHelp

Constructors

constructor

new AbstractSignatureHelpProvider(): AbstractSignatureHelpProvider
Returns AbstractSignatureHelpProvider

Accessors

signatureHelpOptions

get signatureHelpOptions(): SignatureHelpOptions
Override this getter to return the list of triggering characters for your language. To deactivate the signature help, return an empty object.

Returns SignatureHelpOptions
Implementation of SignatureHelpProvider.signatureHelpOptions
- Defined in packages/langium/src/lsp/signature-help-provider.ts:49

Methods

`Protected` `Abstract`getSignatureFromElement

getSignatureFromElement(element, cancelToken): MaybePromise<undefined | SignatureHelp>
Override this method to return the desired SignatureHelp
Parameters
- element: AstNode
- cancelToken: CancellationToken
Returns MaybePromise<undefined | SignatureHelp>
- Defined in packages/langium/src/lsp/signature-help-provider.ts:44

provideSignatureHelp

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