Class ASTCursor

constructor

• new ASTCursor(root: AST, parser: TranslationUnitLike): ASTCursor

  Constructs a new AST cursor.

  Parameters

  • root: AST

    The root node.

  • parser: TranslationUnitLike

    The parser that owns the AST.

  Returns ASTCursor

Readonlyroot

node

• get node(): Token | AST | undefined

  Returns the current AST node or Token.

  Returns Token | AST | undefined

slot

• get slot(): ASTSlot | undefined

  Returns the current AST slot.

  Returns ASTSlot | undefined

gotoFirstChild

• gotoFirstChild(): boolean

  Move the cursor to the first child of the current node.

  Returns boolean

gotoNextSibling

• gotoNextSibling(): boolean

  Move the cursor to the next sibling of the current node.

  Returns boolean

gotoParent

• gotoParent(): boolean

  Move the cursor to the parent of the current node.

  Returns boolean

preVisit

• preVisit(): Generator<ASTVisit>

  Pre-order traversal of the AST.

  Returns Generator<ASTVisit>

  A generator that yields the nodes in pre-order.

stream

• stream(): ReadableStream<ASTVisit>

  Pre-order traversal of the AST as a readable stream.

  Yields the same visits as preVisit, for use with pipeThrough, pipeTo, and for await...of.

  The stream must be consumed, or cancelled, before the parser that owns the AST is disposed.

  Returns ReadableStream<ASTVisit>

  a stream of the nodes in pre-order.