Class DefaultDocumentHighlightProvider

Language-specific service for handling document highlight requests.

Implements

DocumentHighlightProvider

Index

Constructors

Properties

grammarConfig nameProvider references

Methods

createDocumentHighlight getDocumentHighlight

Constructors

constructor

new DefaultDocumentHighlightProvider(
services: LangiumServices,
): DefaultDocumentHighlightProvider
Parameters
- services: LangiumServices
Returns DefaultDocumentHighlightProvider
- Defined in packages/langium/src/lsp/document-highlight-provider.ts:43

Properties

`Protected` `Readonly`grammarConfig

grammarConfig: GrammarConfig

`Protected` `Readonly`nameProvider

nameProvider: NameProvider

`Protected` `Readonly`references

references: References

Methods

`Protected`createDocumentHighlight

createDocumentHighlight(reference: ReferenceDescription): DocumentHighlight
Override this method to determine the highlight kind of the given reference.
Parameters
- reference: ReferenceDescription
Returns DocumentHighlight
- Defined in packages/langium/src/lsp/document-highlight-provider.ts:72

getDocumentHighlight

getDocumentHighlight(
    document: LangiumDocument,
    params: DocumentHighlightParams,
    _cancelToken?: Cancellation.CancellationToken,
): MaybePromise<undefined | DocumentHighlight[]>
Handle a document highlight request.
Parameters
- document: LangiumDocument
  The document in which the request was received.
- params: DocumentHighlightParams
  The parameters of the document highlight request.
- Optional_cancelToken: Cancellation.CancellationToken
Returns MaybePromise<undefined | DocumentHighlight[]>
The document highlights or undefined if no highlights are available.

Throws
OperationCancelled if cancellation is detected during execution

Throws
ResponseError if an error is detected that should be sent as response to the client
Implementation of DocumentHighlightProvider.getDocumentHighlight
- Defined in packages/langium/src/lsp/document-highlight-provider.ts:49