Predicate

Predicates are used to filter queries.

Example:

const predicate = Predicate.equals(myNumberProperty, 1);
const filteredQuery = Query.instancesOf(myModel).filter(predicate).andReturn();

Index

Constructors

• constructor

Methods

• and
• contains
• equals
• greaterThan
• in
• instanceOf
• not
• or
• regex
• smallerThan

Constructors

constructor

• new Predicate(): Predicate

• Returns Predicate

Methods

staticand

• and(...predicates: Predicate[]): Predicate

• Create an AND composite predicate matching a specified set of predicates

  ---

  Parameters

  • rest...predicates: Predicate[]

    list of predicates to match

  Returns Predicate

  new Predicate that should match all specified predicates

staticcontains

• contains(property: Property<string>, value: string, caseSensitive?: boolean): Predicate

• Create a predicate matching a specified string property to a specified string.

  ---

  Parameters

  • property: Property<string>

    the string property to use for filtering

  • value: string

    the value the string property must match

  • optionalcaseSensitive: boolean

    if the match must pay attention to case sensitivity, default value is true

  Returns Predicate

  new Predicate with the contains string operation

staticequals

• equals<T>(property: Property<T>, value: T): Predicate

• Create a predicate matching a specified property to a specified value.

  ---

  Type parameters

  • T

  Parameters

  • property: Property<T>

    the property to use for filtering

  • value: T

    the value the property must match

  Returns Predicate

  new Predicate with the equals operation

staticgreaterThan

• greaterThan(property: Property<number>, value: number, strict?: boolean): Predicate
• greaterThan(property1: Property<number>, property2: Property<number>, strict?: boolean): Predicate

• Create a predicate matching a specified number property to a numerical lower bound

  ---

  Parameters

  • property: Property<number>

    the number property to user for filtering

  • value: number

    the lower bound

  • optionalstrict: boolean

    if the inequality is strict or not

  Returns Predicate

  new Predicate with the greaterThan mathematical operation

staticin

• in(...tags: InstanceOrTag[]): Predicate

• Create a predicate to match the specified object(s).

  ---

  Parameters

  • rest...tags: InstanceOrTag[]

    the object or unique identifier (tag) of the objects to look for.

  Returns Predicate

staticinstanceOf

• instanceOf(expectedModel: InstanceOrTag, extend: boolean): Predicate

• Create a predicate matching the expected model. If extend=true, the predicate will match against inherited models as well

  ---

  Parameters

  • expectedModel: InstanceOrTag

    the expected model

  • extend: boolean

    should the predicate also match against inherited models

  Returns Predicate

  new Predicate

staticnot

• not(predicate: Predicate): Predicate

• Create a NOT predicate matching the opposite of a specified predicate

  ---

  Parameters

  • predicate: Predicate

    the predicate to inverse

  Returns Predicate

  new Predicate that match when the specified predicate does not

staticor

• or(...predicates: Predicate[]): Predicate

• Create an OR composite predicate matching a specified set of predicates

  ---

  Parameters

  • rest...predicates: Predicate[]

    list of predicates to match

  Returns Predicate

  new Predicate that should match at least one specified predicate

staticregex

• regex(property: Property<string>, value: string | RegExp, caseSensitive?: boolean): Predicate

• Create a predicate matching a specified string property to a regular expression.

  ---

  Parameters

  • property: Property<string>

    the string property to use for filtering

  • value: string | RegExp

    the regex or pattern the string property must match

  • optionalcaseSensitive: boolean

    if the match must pay attention to case sensitivity, default value is true

  Returns Predicate

  new Predicate with the match regex operation

staticsmallerThan

• smallerThan(property: Property<number>, value: number, strict?: boolean): Predicate
• smallerThan(property1: Property<number>, property2: Property<number>, strict?: boolean): Predicate

• Create a predicate matching a specified number property to a numerical upper bound

  ---

  Parameters

  • property: Property<number>

    the number property to user for filtering

  • value: number

    the upper bound

  • optionalstrict: boolean

    if the inequality is strict or not

  Returns Predicate

  new Predicate with the smallerThan mathematical operation