Class FunctionalTranslator

A class that extends BaseTranslator to translate structured queries into functional filters.

Example

const functionalTranslator = new FunctionalTranslator();
const relevantDocuments = await functionalTranslator.getRelevantDocuments(
  "Which movies are rated higher than 8.5?",
);

Hierarchy (view full)

Constructors

constructor

Properties

VisitComparisonOutput VisitOperationOutput VisitStructuredQueryOutput allowedComparators allowedOperators

Methods

formatFunction getComparatorFunction getOperatorFunction mergeFilters visitComparison visitOperation visitStructuredQuery

Constructors

constructor

Properties

VisitComparisonOutput

VisitComparisonOutput: FunctionFilter

VisitOperationOutput

VisitOperationOutput: FunctionFilter

VisitStructuredQueryOutput

VisitStructuredQueryOutput: {
    filter: FunctionFilter;
} | {
    [k: string]: never;
}

allowedComparators

allowedComparators: Comparator[]

allowedOperators

allowedOperators: Operator[]

Methods

formatFunction

  • formatFunction(): string

  • Formats a given function (either an operator or a comparator) into a string.

    Returns string

    Formatted string representation of the function.

getComparatorFunction

  • getComparatorFunction<C>(comparator): ((a: string | number, b: ValueType[C]) => boolean)

  • Returns a function that performs a comparison based on the provided comparator.

    Type Parameters

    Parameters

    • comparator: Comparator

      The comparator to base the comparison function on.

    Returns ((a: string | number, b: ValueType[C]) => boolean)

    A function that takes two arguments and returns a boolean based on the comparison.

      • (a, b): boolean

      • Parameters

        • a: string | number
        • b: ValueType[C]

        Returns boolean

getOperatorFunction

  • getOperatorFunction(operator): ((a: boolean, b: boolean) => boolean)

  • Returns a function that performs an operation based on the provided operator.

    Parameters

    • operator: Operator

      The operator to base the operation function on.

    Returns ((a: boolean, b: boolean) => boolean)

    A function that takes two boolean arguments and returns a boolean based on the operation.

      • (a, b): boolean

      • Parameters

        • a: boolean
        • b: boolean

        Returns boolean

mergeFilters

  • mergeFilters(defaultFilter, generatedFilter, mergeType?): undefined | FunctionFilter

  • Merges two filters into one, based on the specified merge type.

    Parameters

    • defaultFilter: FunctionFilter

      The default filter function.

    • generatedFilter: FunctionFilter

      The generated filter function.

    • OptionalmergeType: string

      The type of merge to perform. Can be 'and', 'or', or 'replace'. Default is 'and'.

    Returns undefined | FunctionFilter

    A function that takes a Document as an argument and returns a boolean based on the merged filters, or undefined if both filters are empty.

visitComparison

  • visitComparison(comparison): FunctionFilter

  • Visits the comparison part of a structured query and translates it into a functional filter.

    Parameters

    • comparison: Comparison

      The comparison part of a structured query.

    Returns FunctionFilter

    A function that takes a Document as an argument and returns a boolean based on the comparison.

visitOperation

  • visitOperation(operation): FunctionFilter

  • Visits the operation part of a structured query and translates it into a functional filter.

    Parameters

    • operation: Operation

      The operation part of a structured query.

    Returns FunctionFilter

    A function that takes a Document as an argument and returns a boolean based on the operation.

visitStructuredQuery

  • visitStructuredQuery(query): {
        filter: FunctionFilter;
    } | {
        [k: string]: never;
    }

  • Visits a structured query and translates it into a functional filter.

    Parameters

    Returns {
        filter: FunctionFilter;
    } | {
        [k: string]: never;
    }

    An object containing a filter property, which is a function that takes a Document as an argument and returns a boolean based on the structured query.

Settings

Member Visibility

On This Page

Constructors
Properties
Methods