Class ComplexQuery

Interpreter and test engine for ComplexQueryExpressions.

Example

import ComplexQuery from "store-api/ComplexQuery";

const query = {
  $and : [{
      a : {
          $eqw: "test*"
      },
      $or : [{ x : { $lt : 1 }},
             { x : { $gt : 2 }}]
      }]
}
const options = {};

const cq = ComplexQuery.parse(query, options);

const astRootNode = cq.ast.root();

// the ast root node is an object structure like this:
const expectedRootNode = {
  o : "$and",
  c : [{
     o : "$eqw",
     n : "a",
     v : "test*"
  },
  {
     o : "$or",
     c : [{
          o : $lt,
          n : "x",
          v : 1
       },{
          o : $gt,
          n : "x",
          v : 2
       }]
  }]
}

Properties

Parser ast

Methods

findOperators isComplexQuery parse usesOperator encode encodePostOrder test

Properties

Static Parser

Parser: typeof Parser = Parser

Internally used Parser. Exported to allow new operations. To add a new operator use:

ComplexQuery.Parser.prototype.operators[<name>] = <operator definition>

ast

ast: AST

Normalized syntax tree of the query.

Methods

Static findOperators

  • findOperators(query, queryOptions, operatorName, propertyName?): ASTNode[]

  • Function to find matching ASTNodes in the AST.

    Parameters

    • query: ComplexQueryExpression

      query to parse

    • queryOptions: undefined | ComplexQueryOptions

      query options

    • operatorName: string

      name of operator to find

    • Optional propertyName: string

      name of property referenced by the operator

    Returns ASTNode[]

    array of matching ASTNodes or an empty array if nothing is found.

Static isComplexQuery

  • isComplexQuery(query, queryOptions?): boolean

  • Function to test if a given query is a complex query.

    Parameters

    Returns boolean

    true if the expression is a complex query, otherwise false.

Static parse

Static usesOperator

  • usesOperator(query, queryOptions, operatorName, propertyName?): boolean

  • Function to test if an operator is used within a given query.

    Parameters

    • query: ComplexQueryExpression

      a complex query expression

    • queryOptions: undefined | ComplexQueryOptions

      query options

    • operatorName: string

      name of operator to find

    • Optional propertyName: string

      name of property referenced by the operator

    Returns boolean

    true if the operator is detected in the query.

encode

encodePostOrder

  • encodePostOrder<T>(encoder, walkerOrAst?): any

  • Function to encode the AST or a part of it with a custom encoder.

    Type Parameters

    • T

    Parameters

    • encoder: Encoder<T>

      function which allows the conversion of the AST into another type.

    • Optional walkerOrAst: Walker | AST

      a Walker or AST instance. If not provided the parsed AST is used.

    Returns any

    output of the encoder.

test

  • test(item): boolean

  • Function to test if an item fulfills the conditions of the parsed query.

    Parameters

    • item: any

    Returns boolean

Settings

Member Visibility

Theme

On This Page

ParserastfindOperatorsisComplexQueryparseusesOperatorencodeencodePostOrdertest

Generated using TypeDoc