Interface Visitor<NodeType>

A visitor which handles a node visited by a TreeWalker.

interface Visitor<NodeType extends Node> {
    getChildren(
        node: NodeType,
        context: Context<NodeType>,
    ): undefined | void | NodeType[] | Iterable<NodeType>;
    postVisit(node: NodeType, context: Context<NodeType>): void | VisitCodes;
    preVisit(node: NodeType, context: Context<NodeType>): void | VisitCodes;
}

Type Parameters

NodeType extends Node

Index

Methods

getChildren postVisit preVisit

Methods

getChildren

getChildren(
node: NodeType,
context: Context<NodeType>,
): undefined | void | NodeType[] | Iterable<NodeType>
Retrieves all children at a given node. HINT: This not necessarily have to be the children of the current node. An implementation may give the visitor a chance to return an arbitrary list of child nodes. By default, the node's children are considered to walk deeper the tree.
Parameters
- node: NodeType
  The current node.
- context: Context<NodeType>
  The walker's context at current node.
Returns undefined | void | NodeType[] | Iterable<NodeType>
Indicates how the walker shall proceed, the default is VisitCodes.CONTINUE.
- Defined in TreeWalker.ts:80

postVisit

postVisit(node: NodeType, context: Context<NodeType>): void | VisitCodes
Node handle to do something after visiting the node's children.
Parameters
- node: NodeType
  The current node.
- context: Context<NodeType>
  The walker's context at current node.
Returns void | VisitCodes
Indicates how the walker shall proceed, the default is VisitCodes.CONTINUE.
- Defined in TreeWalker.ts:69

preVisit

preVisit(node: NodeType, context: Context<NodeType>): void | VisitCodes
Node handle to do something before visiting the node's children.
Parameters
- node: NodeType
  The current node.
- context: Context<NodeType>
  The walker's context at current node.
Returns void | VisitCodes
Indicates how the walker shall proceed, the default is VisitCodes.CONTINUE.
- Defined in TreeWalker.ts:61