Interface References

Language-specific service for finding references and declaration of a given CstNode.

interface References {
    findDeclarationNodes(sourceCstNode: CstNode): CstNode[];
    findDeclarations(sourceCstNode: CstNode): AstNode[];
    findReferences(
        targetNode: AstNode,
        options: FindReferencesOptions,
    ): Stream<ReferenceDescription>;
}

Implemented by

DefaultReferences

Index

Methods

findDeclarationNodes findDeclarations findReferences

Methods

findDeclarationNodes

findDeclarationNodes(sourceCstNode: CstNode): CstNode[]
If the CstNode is a reference node the target CstNodes will be returned. If the CstNode is a significant node of the CstNode this CstNode will be returned.
Parameters
- sourceCstNode: CstNode
  CstNode that points to a AstNode
Returns CstNode[]
- Defined in packages/langium/src/references/references.ts:43

findDeclarations

findDeclarations(sourceCstNode: CstNode): AstNode[]
If the CstNode is a reference node the target AstNodes will be returned. If the CstNode is a significant node of the CstNode this AstNode will be returned.
Parameters
- sourceCstNode: CstNode
  CstNode that points to a AstNode
Returns AstNode[]
- Defined in packages/langium/src/references/references.ts:35

findReferences

findReferences(
targetNode: AstNode,
options: FindReferencesOptions,
): Stream<ReferenceDescription>
Finds all references to the target node as references (local references) or reference descriptions.
Parameters
- targetNode: AstNode
  Specified target node whose references should be returned
- options: FindReferencesOptions
Returns Stream<ReferenceDescription>
- Defined in packages/langium/src/references/references.ts:50