Interface: ParseWhereOptions<T>

Defined in: packages/db/src/query/expression-helpers.ts:53

Options for customizing how WHERE expressions are parsed

Type Parameters

T

T = any

Properties

handlers

handlers: object & object;

handlers: object & object;

Defined in: packages/db/src/query/expression-helpers.ts:67

Handler functions for different operators. Each handler receives the parsed field path(s) and value(s) and returns your custom format.

Supported operators from TanStack DB:

Comparison: eq, gt, gte, lt, lte, in, like, ilike
Logical: and, or, not
Null checking: isNull, isUndefined
String functions: upper, lower, length, concat
Numeric: add
Utility: coalesce
Aggregates: count, avg, sum, min, max

Type Declaration

add()?

optional add: (...args) => T;

optional add: (...args) => T;

Parameters

args

...any[]

Returns

and()?

optional and: (...args) => T;

optional and: (...args) => T;

Parameters

args

...any[]

Returns

avg()?

optional avg: (...args) => T;

optional avg: (...args) => T;

Parameters

args

...any[]

Returns

coalesce()?

optional coalesce: (...args) => T;

optional coalesce: (...args) => T;

Parameters

args

...any[]

Returns

concat()?

optional concat: (...args) => T;

optional concat: (...args) => T;

Parameters

args

...any[]

Returns

count()?

optional count: (...args) => T;

optional count: (...args) => T;

Parameters

args

...any[]

Returns

eq()?

optional eq: (...args) => T;

optional eq: (...args) => T;

Parameters

args

...any[]

Returns

gt()?

optional gt: (...args) => T;

optional gt: (...args) => T;

Parameters

args

...any[]

Returns

gte()?

optional gte: (...args) => T;

optional gte: (...args) => T;

Parameters

args

...any[]

Returns

ilike()?

optional ilike: (...args) => T;

optional ilike: (...args) => T;

Parameters

args

...any[]

Returns

in()?

optional in: (...args) => T;

optional in: (...args) => T;

Parameters

args

...any[]

Returns

isNull()?

optional isNull: (...args) => T;

optional isNull: (...args) => T;

Parameters

args

...any[]

Returns

isUndefined()?

optional isUndefined: (...args) => T;

optional isUndefined: (...args) => T;

Parameters

args

...any[]

Returns

length()?

optional length: (...args) => T;

optional length: (...args) => T;

Parameters

args

...any[]

Returns

like()?

optional like: (...args) => T;

optional like: (...args) => T;

Parameters

args

...any[]

Returns

lower()?

optional lower: (...args) => T;

optional lower: (...args) => T;

Parameters

args

...any[]

Returns

lt()?

optional lt: (...args) => T;

optional lt: (...args) => T;

Parameters

args

...any[]

Returns

lte()?

optional lte: (...args) => T;

optional lte: (...args) => T;

Parameters

args

...any[]

Returns

max()?

optional max: (...args) => T;

optional max: (...args) => T;

Parameters

args

...any[]

Returns

min()?

optional min: (...args) => T;

optional min: (...args) => T;

Parameters

args

...any[]

Returns

not()?

optional not: (...args) => T;

optional not: (...args) => T;

Parameters

args

...any[]

Returns

or()?

optional or: (...args) => T;

optional or: (...args) => T;

Parameters

args

...any[]

Returns

sum()?

optional sum: (...args) => T;

optional sum: (...args) => T;

Parameters

args

...any[]

Returns

upper()?

optional upper: (...args) => T;

optional upper: (...args) => T;

Parameters

args

...any[]

Returns

onUnknownOperator()?

optional onUnknownOperator: (operator, args) => T;

optional onUnknownOperator: (operator, args) => T;

Defined in: packages/db/src/query/expression-helpers.ts:76

Optional handler for when an unknown operator is encountered. If not provided, unknown operators throw an error.