Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PathExpressionQueryOptions

Options for performing a path expression query against a project

Hierarchy

  • PathExpressionQueryOptions

Index

Properties

Optional cacheAst

cacheAst: boolean

Whether to cache the AST for the given parser for this file. Caching will occur unless this property is explicitly set to false. Disable caching if many files are likely to be parsed as one offs.

Optional fileFilter

fileFilter: (f: File) => Promise<boolean>

Optional filter to exclude files before parse phase. This can increase efficiency by preventing unnecessary parsing.

Type declaration

    • (f: File): Promise<boolean>
    • Parameters

      Returns Promise<boolean>

Optional functionRegistry

functionRegistry: FunctionRegistry

functionRegistry registry to look for path expression functions in

globPatterns

globPatterns: GlobOptions

Glob pattern or patterns describing files to match

parseWith

Parser or parsers to use to parse files

pathExpression

pathExpression: string | PathExpression

Path expression to execute

Optional testWith

Optionally return a tester for matches in this file, testing the node backing the match. This can be useful for contextual testing: E.g. testing if one match is within another.

param
returns

Generated using TypeDoc