ParseWhereOptions

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

Options for customizing how WHERE expressions are parsed

Type Parameters#

T#

T = any

Properties#

handlers#

handlers: object & object;

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

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;

Parameters#

args#

...any[]

Returns#

T

and()?#

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

Parameters#

args#

...any[]

Returns#

T

avg()?#

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

Parameters#

args#

...any[]

Returns#

T

caseWhen()?#

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

Parameters#

args#

...any[]

Returns#

T

coalesce()?#

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

Parameters#

args#

...any[]

Returns#

T

concat()?#

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

Parameters#

args#

...any[]

Returns#

T

count()?#

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

Parameters#

args#

...any[]

Returns#

T

divide()?#

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

Parameters#

args#

...any[]

Returns#

T

eq()?#

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

Parameters#

args#

...any[]

Returns#

T

gt()?#

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

Parameters#

args#

...any[]

Returns#

T

gte()?#

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

Parameters#

args#

...any[]

Returns#

T

ilike()?#

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

Parameters#

args#

...any[]

Returns#

T

in()?#

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

Parameters#

args#

...any[]

Returns#

T

isNull()?#

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

Parameters#

args#

...any[]

Returns#

T

isUndefined()?#

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

Parameters#

args#

...any[]

Returns#

T

length()?#

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

Parameters#

args#

...any[]

Returns#

T

like()?#

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

Parameters#

args#

...any[]

Returns#

T

lower()?#

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

Parameters#

args#

...any[]

Returns#

T

lt()?#

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

Parameters#

args#

...any[]

Returns#

T

lte()?#

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

Parameters#

args#

...any[]

Returns#

T

max()?#

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

Parameters#

args#

...any[]

Returns#

T

min()?#

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

Parameters#

args#

...any[]

Returns#

T

multiply()?#

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

Parameters#

args#

...any[]

Returns#

T

not()?#

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

Parameters#

args#

...any[]

Returns#

T

or()?#

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

Parameters#

args#

...any[]

Returns#

T

subtract()?#

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

Parameters#

args#

...any[]

Returns#

T

sum()?#

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

Parameters#

args#

...any[]

Returns#

T

upper()?#

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

Parameters#

args#

...any[]

Returns#

T

onUnknownOperator()?#

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

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

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

Parameters#

operator#

string

args#

any[]

Returns#

T