Skip to content
API/FilterOperatorEnum

FilterOperatorEnum

src/enums/filter-operator.enum.tsenum

Enum representing the available filter operators for explicit operator filters

NestJS encodes these with the $ prefix at the wire level (filter.field=$operator:value); PostgREST translates them to its own prefix notation (col=eq.val, col=is.null, etc.). The enum values are intentionally the NestJS form; each driver’s request strategy is responsible for mapping them into its own shape.

FTS, PLFTS, PHFTS, WFTS are PostgREST-native full-text search variants; they throw UnsupportedFilterOperatorError on every other driver that does not recognise them.

Member Value Description
BTW '$btw' —
CONTAINS '$contains' —
EQ '$eq' —
FTS '$fts' —
GT '$gt' —
GTE '$gte' —
ILIKE '$ilike' —
IN '$in' —
LT '$lt' —
LTE '$lte' —
NOT '$not' —
NULL '$null' —
PHFTS '$phfts' —
PLFTS '$plfts' —
SW '$sw' —
WFTS '$wfts' —