Interface AstNodeLocator

Language-specific service for locating an AstNode in a document.

interface AstNodeLocator {
    getAstNode<T extends AstNode = AstNode>(
        node: AstNode,
        path: string,
    ): undefined | T;
    getAstNodePath(node: AstNode): string;
}

Implemented by

DefaultAstNodeLocator

Index

Methods

getAstNode getAstNodePath

Methods

getAstNode

getAstNode<T extends AstNode = AstNode>(
node: AstNode,
path: string,
): undefined | T
Locates an AstNode inside another node by following the given path.
Type Parameters
- T extends AstNode = AstNode
Parameters
- node: AstNode
  Parent element.
- path: string
  Describes how to locate the AstNode inside the given node.
Returns undefined | T
The AstNode located under the given path, or undefined if the path cannot be resolved.

See
getAstNodePath
- Defined in packages/langium/src/workspace/ast-node-locator.ts:32

getAstNodePath

getAstNodePath(node: AstNode): string
Creates a path represented by a string that identifies an AstNode inside its document. It must be possible to retrieve exactly the same AstNode from the document using this path.
Parameters
- node: AstNode
  The AstNode for which to create the path.
Returns string
a path represented by a string that identifies node inside its document.

See
getAstNode
- Defined in packages/langium/src/workspace/ast-node-locator.ts:22