Skip to main content
Version: 3.3.0

IOperatorFilter

Defined in: src/lib/interfaces/operator-filter.interface.ts:19

Represents a filter with an explicit operator for the NestJS driver

Operator filters produce query parameters in the format: filter.field=$operator:value

Example

const filter: IOperatorFilter = {
field: 'age',
operator: FilterOperatorEnum.GTE,
values: [18]
};
// Produces: filter.age=$gte:18

Properties

field

field: string

Defined in: src/lib/interfaces/operator-filter.interface.ts:21

The field name to filter on


operator

operator: FilterOperatorEnum

Defined in: src/lib/interfaces/operator-filter.interface.ts:23

The filter operator to apply


values

values: (string | number | boolean)[]

Defined in: src/lib/interfaces/operator-filter.interface.ts:25

The value(s) for the filter