Class DefaultReferencesProvider

Language-specific service for handling find references requests.

Implements

ReferencesProvider

Index

Constructors

Properties

grammarConfig nameProvider references

Methods

findReferences getReferences

Constructors

constructor

new DefaultReferencesProvider(
services: LangiumServices,
): DefaultReferencesProvider
Parameters
- services: LangiumServices
Returns DefaultReferencesProvider
- Defined in packages/langium/src/lsp/references-provider.ts:42

Properties

`Protected` `Readonly`grammarConfig

grammarConfig: GrammarConfig

`Protected` `Readonly`nameProvider

nameProvider: NameProvider

`Protected` `Readonly`references

references: References

Methods

findReferences

findReferences(
    document: LangiumDocument,
    params: ReferenceParams,
    _cancelToken?: Cancellation.CancellationToken,
): MaybePromise<Location[]>
Handle a find references request.
Parameters
- document: LangiumDocument
  The document in which to search for references.
- params: ReferenceParams
  The parameters of the find references request.
- Optional_cancelToken: Cancellation.CancellationToken
Returns MaybePromise<Location[]>
The locations of the references.

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 ReferencesProvider.findReferences
- Defined in packages/langium/src/lsp/references-provider.ts:48

`Protected`getReferences

getReferences(
    selectedNode: LeafCstNode,
    params: ReferenceParams,
    _document: LangiumDocument,
): Location[]
Parameters
- selectedNode: LeafCstNode
- params: ReferenceParams
- _document: LangiumDocument
Returns Location[]
- Defined in packages/langium/src/lsp/references-provider.ts:62