Skip to content

@oneplatform/sdk


@oneplatform/sdk / FieldConditionBuilder

Interface: FieldConditionBuilder

Defined in: packages/sdk/src/filter-builder/filter-builder.ts:33

Extends FilterBuilder with operator methods. Returned by filter() and and().

Extends

Methods

and()

and(field): FieldConditionBuilder

Defined in: packages/sdk/src/filter-builder/filter-builder.ts:26

Add a condition on a new field. Returns a FieldConditionBuilder for operator selection.

Parameters

field

string

Returns

FieldConditionBuilder

Inherited from

FilterBuilder.and


eq()

eq(value): FilterBuilder

Defined in: packages/sdk/src/filter-builder/filter-builder.ts:34

Parameters

value

string | number | boolean

Returns

FilterBuilder


gt()

gt(value): FilterBuilder

Defined in: packages/sdk/src/filter-builder/filter-builder.ts:36

Parameters

value

string | number

Returns

FilterBuilder


gte()

gte(value): FilterBuilder

Defined in: packages/sdk/src/filter-builder/filter-builder.ts:37

Parameters

value

string | number

Returns

FilterBuilder


in()

in(values): FilterBuilder

Defined in: packages/sdk/src/filter-builder/filter-builder.ts:41

Parameters

values

(string | number)[]

Returns

FilterBuilder


like()

like(pattern): FilterBuilder

Defined in: packages/sdk/src/filter-builder/filter-builder.ts:40

Parameters

pattern

string

Returns

FilterBuilder


lt()

lt(value): FilterBuilder

Defined in: packages/sdk/src/filter-builder/filter-builder.ts:38

Parameters

value

string | number

Returns

FilterBuilder


lte()

lte(value): FilterBuilder

Defined in: packages/sdk/src/filter-builder/filter-builder.ts:39

Parameters

value

string | number

Returns

FilterBuilder


neq()

neq(value): FilterBuilder

Defined in: packages/sdk/src/filter-builder/filter-builder.ts:35

Parameters

value

string | number | boolean

Returns

FilterBuilder


null()

null(isNull): FilterBuilder

Defined in: packages/sdk/src/filter-builder/filter-builder.ts:43

true = filter to null values; false = filter to non-null values.

Parameters

isNull

boolean

Returns

FilterBuilder


toParams()

toParams(): Record\<string, string>

Defined in: packages/sdk/src/filter-builder/filter-builder.ts:29

Serialize all accumulated conditions to query param key/value pairs.

Returns

Record\<string, string>

Inherited from

FilterBuilder.toParams