A fluent API operation for creating a filter for a query by chaining different rules.

Type Parameters

  • QueryType

Hierarchy

  • WhereQuery

Constructors

  • Type Parameters

    • QueryType

    Parameters

    • parent: QueryType
    • type: string = EXPRESSION_TYPE.and

    Returns WhereQuery<QueryType>

Properties

expression: ComplexExpression
parent: QueryType

Methods

  • Parameters

    Returns void

  • Adds a condition that a field value must contain a specified string.

    Parameters

    • parameter: string
    • constant: any
    • caseSensitive: boolean = true

    Returns WhereQuery<QueryType>

  • Ends the definition of the current WhereQuery. You need to call this method in order to continue with the definition of the parent Query. All other WhereQuery methods return the current instance of WhereQuery to allow chaining.

    Returns QueryType

  • Adds a condition that a field value must end with a specified string.

    Parameters

    • parameter: string
    • constant: any
    • caseSensitive: boolean = true

    Returns WhereQuery<QueryType>

  • Adds a condition that a field must be equal to a specific value.

    Parameters

    • parameter: string
    • constant: any

    Returns WhereQuery<QueryType>

  • Adds a condition that a field must be greater than a certain value. Applicable to Number, String, and Date fields.

    Parameters

    • parameter: string
    • constant: any

    Returns WhereQuery<QueryType>

  • Adds a condition that a field must be greater than or equal to a certain value. Applicable to Number, String, and Date fields.

    Parameters

    • parameter: string
    • constant: any

    Returns WhereQuery<QueryType>

  • Adds a condition that specific values should be found in that field e.g. Id in (id1, id2, id3).

    Parameters

    • parameter: string
    • constant: any

    Returns WhereQuery<QueryType>

  • Adds a condition that a field must be less than a certain value. Applicable to Number, String, and Date fields.

    Parameters

    • parameter: string
    • constant: any

    Returns WhereQuery<QueryType>

  • Adds a condition that a field must be less than or equal to a certain value. Applicable to Number, String, and Date fields.

    Parameters

    • parameter: string
    • constant: any

    Returns WhereQuery<QueryType>

  • Adds a condition that a field must not be equal to a specific value.

    Parameters

    • parameter: string
    • constant: any

    Returns WhereQuery<QueryType>

  • Parameters

    • type: string
    • parameter: string
    • constant: any
    • caseSensitive: boolean = true

    Returns WhereQuery<QueryType>

  • Adds a condition that a field value must start with a specified string.

    Parameters

    • parameter: string
    • constant: any
    • caseSensitive: boolean = true

    Returns WhereQuery<QueryType>

Generated using TypeDoc