Interface Walker

ROOT

current

currentIndex

parents

queryOptions

child

• child(childIndex): undefined | ASTNode

• Function to pick the child at a given index.

  Parameters

  • childIndex: number

  Returns undefined | ASTNode

children

• children(): ASTNode[]

• Function to pick the child nodes of the current node.

  Returns ASTNode[]

childrenCount

• childrenCount(): number

• Function to get the number of children of the current node.

  Returns number

hasChild

• hasChild(childIndex): boolean

• Function to check if the child at a given index exists.

  Parameters

  • childIndex: number

  Returns boolean

hasChildren

• hasChildren(): boolean

• Function to check if the current node has children.

  Returns boolean

hasNextSibling

• hasNextSibling(): boolean

• Function to check if the next sibling exists.

  Returns boolean

hasParent

• hasParent(): boolean

• Function to check if the current node has a parent.

  Returns boolean

hasPrevSibling

• hasPrevSibling(): boolean

• Function to check if the previous sibling exists.

  Returns boolean

isROOT

• isROOT(node?): boolean

• Function to check if a given node is the root of the AST. If no parameter is provided, this function will test if the walker is at the root position of the AST.

  Parameters

  • Optional node: ASTNode

  Returns boolean

parent

• parent(): undefined | ASTNode

• Function to pick the parent of the current node.

  Returns undefined | ASTNode

sibling

• sibling(offsetFromCurrentPosition): undefined | ASTNode

• Function to pick a sibling at an offset relative to the current position.

  Parameters

  • offsetFromCurrentPosition: number

  Returns undefined | ASTNode

toAncestor

• toAncestor(offset): undefined | Walker

• Function to move the walker to an ancestor with given an offset. e.g. 1=direct parent, 2 = grandparent, ...

  Parameters

  • offset: number

  Returns undefined | Walker

toChild

• toChild(childIndex): undefined | Walker

• Function to move the walker to the child at a given index.

  Parameters

  • childIndex: number

  Returns undefined | Walker

toFirstChild

• toFirstChild(): undefined | Walker

• Function to move the walker to the first child.

  Returns undefined | Walker

toLastChild

• toLastChild(): undefined | Walker

• Function to move the walker to the last child.

  Returns undefined | Walker

toNextSibling

• toNextSibling(): undefined | Walker

• Function to move the walker to the next sibling.

  Returns undefined | Walker

toParent

• toParent(): undefined | Walker

• Function to move the walker to the current parent.

  Returns undefined | Walker

toPrevSibling

• toPrevSibling(): undefined | Walker

• Function to move the walker to the previous sibling.

  Returns undefined | Walker

toROOT

• toROOT(): Walker

• Function to move the walker to the AST root.

  Returns Walker

toSibling

• toSibling(offsetFromCurrentPosition): undefined | Walker

• Function to move the walker to a sibling with an offset relative to the current position.

  Parameters

  • offsetFromCurrentPosition: number

  Returns undefined | Walker

walk

• walk(cb, scope?): void

• Function to walk over the AST. The visitor callback is called twice for every node.

  Parameters

  • cb: VisitCallback
  • Optional scope: any

  Returns void

walkChildren

• walkChildren(cb, scope?): void

• Function to walk over all children.

  Parameters

  • cb: ChildVisitCallback
  • Optional scope: any

  Returns void

walkPostOrder

• walkPostOrder(cb, scope?): void

• Function to walk over the AST. The visitor callback is called once for every node. Parents are visited after the children.

  Parameters

  • cb: VisitCallback
  • Optional scope: any

  Returns void

walkPreOrder

• walkPreOrder(cb, scope?): void

• Function to walk over the AST. The visitor callback is called once for every node. Parents are visited before the children.

  Parameters

  • cb: VisitCallback
  • Optional scope: any

  Returns void

walker

• walker(): Walker

• Function to create a new walker at the current node position.

  Returns Walker