Class Match

A utility class for matching against the AST using queries.

[tree-sitter query reference](https://tree-sitter.github.io/tree-sitter/using-parsers#pattern-matching-with-queries

Index

Constructors

Methods

getSyntax getLastSyntax requireSyntax getSyntaxMany getBlock getManyBlocks

Constructors

constructor

new Match(
    match: QueryMatch,
    blockHandler: BlockHandler,
    dispatchSingle: (syntax: Node) => BasicBlock,
): Match
Parameters
- match: QueryMatch
- blockHandler: BlockHandler
- dispatchSingle: (syntax: Node) => BasicBlock
Returns Match
- Defined in block-matcher.ts:106

Methods

getSyntax

getSyntax(name: string): undefined | Node
Returns the first named syntax node from the query match, if present.
Parameters
- name: string
  Name of the capture
Returns undefined | Node
The syntax matching the capture name, if captured.
- Defined in block-matcher.ts:121

getLastSyntax

getLastSyntax(name: string): undefined | Node
Returns the last named syntax node from the query match, if present.
Parameters
- name: string
  Name of the capture
Returns undefined | Node
- Defined in block-matcher.ts:129

requireSyntax

requireSyntax(name: string): Node
Returns the first named syntax node from the query match. Throws an error if no matching node exists.
Parameters
- name: string
Returns Node
- Defined in block-matcher.ts:138

getSyntaxMany

getSyntaxMany(name: string): Node[]
Returns the all named syntax nodes from the query match.
Parameters
- name: string
  Name of the capture
Returns Node[]
- Defined in block-matcher.ts:145

getBlock

getBlock(syntax: Node): BasicBlock
Parameters
- syntax: Node
Returns BasicBlock
- Defined in block-matcher.ts:149
getBlock(syntax: undefined | null | Node): null | BasicBlock
Parameters
- syntax: undefined | null | Node
Returns null | BasicBlock
- Defined in block-matcher.ts:150

getManyBlocks

getManyBlocks(syntaxMany: Node[]): BasicBlock[]
Parameters
- syntaxMany: Node[]
Returns BasicBlock[]
- Defined in block-matcher.ts:157