FilterBuilder has various methods that produce Expressions.
These expressions can be nested together along with constants to express
a filter predicate.
FilterBuilder is used within filter to create query
filters.
Here are the available methods:
Type parameters
Methods
eq
▸ eq<T>(l, r): Expression<boolean>
l === r
Type parameters
Parameters
Returns
Expression<boolean>
neq
▸ neq<T>(l, r): Expression<boolean>
l !== r
Type parameters
Parameters
Returns
Expression<boolean>
lt
▸ lt<T>(l, r): Expression<boolean>
l < r
Type parameters
Parameters
Returns
Expression<boolean>
lte
▸ lte<T>(l, r): Expression<boolean>
l <= r
Type parameters
Parameters
Returns
Expression<boolean>
gt
▸ gt<T>(l, r): Expression<boolean>
l > r
Type parameters
Parameters
Returns
Expression<boolean>
gte
▸ gte<T>(l, r): Expression<boolean>
l >= r
Type parameters
Parameters
Returns
Expression<boolean>
add
▸ add<T>(l, r): Expression<T>
l + r
Type parameters
Parameters
Returns
Expression<T>
sub
▸ sub<T>(l, r): Expression<T>
l - r
Type parameters
Parameters
Returns
Expression<T>
mul
▸ mul<T>(l, r): Expression<T>
l * r
Type parameters
Parameters
Returns
Expression<T>
div
▸ div<T>(l, r): Expression<T>
l / r
Type parameters
Parameters
Returns
Expression<T>
mod
▸ mod<T>(l, r): Expression<T>
l % r
Type parameters
Parameters
Returns
Expression<T>
neg
▸ neg<T>(x): Expression<T>
-x
Type parameters
Parameters
Returns
Expression<T>
and
▸ and(...exprs): Expression<boolean>
exprs[0] && exprs[1] && ... && exprs[n]
Parameters
Returns
Expression<boolean>
or
▸ or(...exprs): Expression<boolean>
exprs[0] || exprs[1] || ... || exprs[n]
Parameters
Returns
Expression<boolean>
not
▸ not(x): Expression<boolean>
!x
Parameters
Returns
Expression<boolean>
field
▸ field<FieldPath>(fieldPath): Expression<FieldTypeFromFieldPath<DocumentByInfo<TableInfo>, FieldPath>>
Evaluates to the field at the given fieldPath.
For example, in filter this can be used to examine the values being filtered.
Example
On this object:field("user.isActive") evaluates to true.
Type parameters
Parameters
Returns
Expression<FieldTypeFromFieldPath<DocumentByInfo<TableInfo>, FieldPath>>