Class Query

constructor

• new Query(language: Language, source: string | Buffer): Query

• Create a new query from a string containing one or more S-expression patterns.

  The query is associated with a particular language, and can only be run on syntax nodes parsed with that language. References to Queries can be shared between multiple threads.

  Parameters

  • language: Language
  • source: string | Buffer

  Returns Query

ReadonlymatchLimit

captures

• captures(node: SyntaxNode, options?: QueryOptions): QueryCapture[]

• Iterate over all of the individual captures in the order that they appear.

  This is useful if you don't care about which pattern matched, and just want a single, ordered sequence of captures.

  Parameters

  • node: SyntaxNode

    The syntax node to query
  • Optionaloptions: QueryOptions

    Optional query options

  Returns QueryCapture[]

  An array of captures

didExceedMatchLimit

• didExceedMatchLimit(): boolean

• Check if, on its last execution, this cursor exceeded its maximum number of in-progress matches.

  Returns boolean

  true if the cursor exceeded its match limit

disableCapture

• disableCapture(captureName: string): void

• Disable a certain capture within a query.

  This prevents the capture from being returned in matches, and also avoids any resource usage associated with recording the capture.

  Parameters

  • captureName: string

    The name of the capture to disable

  Returns void

disablePattern

• disablePattern(patternIndex: number): void

• Disable a certain pattern within a query.

  This prevents the pattern from matching, and also avoids any resource usage associated with the pattern.

  Parameters

  • patternIndex: number

    The index of the pattern to disable

  Returns void

endIndexForPattern

• endIndexForPattern(patternIndex: number): number

• Get the byte offset where the given pattern ends in the query's source.

  Parameters

  • patternIndex: number

    The index of the pattern to check

  Returns number

  The byte offset where the pattern ends

isPatternGuaranteedAtStep

• isPatternGuaranteedAtStep(byteOffset: number): boolean

• Check if a given step in a query is 'definite'.

  A query step is 'definite' if its parent pattern will be guaranteed to match successfully once it reaches the step.

  Parameters

  • byteOffset: number

    The byte offset of the step to check

  Returns boolean

isPatternNonLocal

• isPatternNonLocal(patternIndex: number): boolean

• Check if a given pattern within a query has a single root node.

  Parameters

  • patternIndex: number

    The index of the pattern to check

  Returns boolean

isPatternRooted

• isPatternRooted(patternIndex: number): boolean

• Check if a given pattern within a query has a single root node.

  Parameters

  • patternIndex: number

    The index of the pattern to check

  Returns boolean

matches

• matches(node: SyntaxNode, options?: QueryOptions): QueryMatch[]

• Iterate over all of the matches in the order that they were found.

  Each match contains the index of the pattern that matched, and a list of captures. Because multiple patterns can match the same set of nodes, one match may contain captures that appear before some of the captures from a previous match.

  Parameters

  • node: SyntaxNode

    The syntax node to query
  • Optionaloptions: QueryOptions

    Optional query options

  Returns QueryMatch[]

  An array of matches

startIndexForPattern

• startIndexForPattern(patternIndex: number): number

• Get the byte offset where the given pattern starts in the query's source.

  Parameters

  • patternIndex: number

    The index of the pattern to check

  Returns number

  The byte offset where the pattern starts