Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Compiler

Hierarchy

  • Compiler

Index

Methods

compile

  • Takes a search payload that contains a predicate and additional filters and returns a set of results.

    Type parameters

    • M: Model

    Parameters

    • search: Search

      the search to compile

    • model: ModelClass<M>

      the model to search on

    Returns QueryBuilder<M, M[]>

mapAliases

  • mapAliases(fields: string[], aliases?: Search["aliases"]): string[]
  • Maps a set of aliases onto fields

    Parameters

    • fields: string[]
    • Optional aliases: Search["aliases"]

    Returns string[]

processComparisonNode

  • A comparison node is on that uses a comparison function (e.g. '<', '>', '=', etc.). It takes no children so we simply modify the builder.

    Parameters

    Returns void

processFields

  • processFields(fields: string[], builder: QueryBuilder<Model>, aliases?: Search["aliases"]): void
  • Processes 'fields' in the Search payload, and modifies the query builder.

    Parameters

    • fields: string[]
    • builder: QueryBuilder<Model>
    • Optional aliases: Search["aliases"]

    Returns void

processLogicalNode

  • A logical node is one that uses a logical function (e.g. 'match_all' or 'match_any'). This method modifies the builder using the respective predicate function and recursively calls processNode() for any child nodes.

    Parameters

    Returns void

processNode

  • processNode(node: Node, qb: QueryBuilder<Model>, builderFn: BuilderFunction, rootTable: string): void

Generated using TypeDoc