Class

FilterBuilder

FilterBuilder

This class provides different matchers to build search filters

Methods

eq(value) → {SearchFilter}

Equals matcher for search filter

Parameters:
Name Type Description
value Date | number | boolean | string

A value to match.

search filter using this matcher.

SearchFilter

gt(value) → {SearchFilter}

Greater-Than matcher for search filters

Parameters:
Name Type Description
value number | Date

A value to match.

search filter using this matcher.

SearchFilter

gte(value) → {SearchFilter}

Greater-Than-Equals matcher for search filters.

Parameters:
Name Type Description
value number | Date

A value to match.

search filter using this matcher.

SearchFilter

isIn(values) → {SearchFilter}

In matcher for search filters.

Parameters:
Name Type Description
values ArrayLike

Attribute values to match.

search filter using this matcher.

SearchFilter

lt(value) → {SearchFilter}

Less-Than matcher for search filters

Parameters:
Name Type Description
value number | Date

A value to match.

search filter using this matcher.

SearchFilter

lte(value) → {SearchFilter}

Less-Than-Equals matcher for search filters

Parameters:
Name Type Description
value number | Date

A value to match.

search filter using this matcher.

SearchFilter

referenceIn(values) → {SearchFilter}

References-In matcher for search filters.

Note that for reference values you have to either provide a Uid string or a CustomEntity object.

Parameters:
Name Type Description
values ArrayLike.<(string|CustomEntity)>

Reference values to match.

search filter using this matcher.

SearchFilter

references(value) → {SearchFilter}

Reference equals matcher for search filter.

This matcher only takes a custom entity object or the Uid string of an entity.

Parameters:
Name Type Description
value string | CustomEntity

Reference value to match.

search filter using this matcher.

SearchFilter

startsWith(value) → {SearchFilter}

Starts-With matcher for search filters.

Parameters:
Name Type Description
value string

String value to match.

search filter using this matcher.

SearchFilter