where

const where: object

Defined in: packages/schema/src/filter/where.ts:123

Builds a filter in code instead of writing filter text, for any resource; createWhere checks names and values against one. The Filters of the API take what it builds.

Type Declaration

ago

ago: (duration) => FilterValue

A time the duration before now, such as ago('7d') for now() - 7d; units are s, m, h, d and w.

Parameters

duration

string

Returns

FilterValue

and

and: (…args) => FilterExpr

Every filter holds; one filter is returned as it is, none throws.

Parameters

args

…FilterExpr[]

Returns

FilterExpr

between

between: <K>(name, low, high) => FilterExpr

The field lies from low to high, both included.

Type Parameters

K

K extends string

Parameters

name

K

low

any

high

any

Returns

FilterExpr

eq

eq: <K>(name, value) => FilterExpr

The field equals the value: status = "paid".

Type Parameters

K

K extends string

Parameters

name

K

value

any

Returns

FilterExpr

fromNow

fromNow: (duration) => FilterValue

A time the duration after now, such as fromNow('1h') for now() + 1h.

Parameters

duration

string

Returns

FilterValue

gt

gt: <K>(name, value) => FilterExpr

The field is above the value: total > 100.

Type Parameters

K

K extends string

Parameters

name

K

value

any

Returns

FilterExpr

gte

gte: <K>(name, value) => FilterExpr

The field is at least the value: total >= 100.

Type Parameters

K

K extends string

Parameters

name

K

value

any

Returns

FilterExpr

has

has: <K>(name, value) => FilterExpr

A JSON field holds the value, as a key or an element: tags:"urgent".

Type Parameters

K

K extends string

Parameters

name

K

value

string | number | false | true

Returns

FilterExpr

in

in: <K>(name, values) => FilterExpr

The field equals one of the values: in(status, "paid", "sent").

Type Parameters

K

K extends string

Parameters

name

K

values

any[]

Returns

FilterExpr

isNull

isNull: <K>(name) => FilterExpr

The field has no value: isNull(field).

Type Parameters

K

K extends string

Parameters

name

K

Returns

FilterExpr

lt

lt: <K>(name, value) => FilterExpr

The field is below the value: total < 100.

Type Parameters

K

K extends string

Parameters

name

K

value

any

Returns

FilterExpr

lte

lte: <K>(name, value) => FilterExpr

The field is at most the value: total <= 100.

Type Parameters

K

K extends string

Parameters

name

K

value

any

Returns

FilterExpr

ne

ne: <K>(name, value) => FilterExpr

The field differs from the value: status != "paid".

Type Parameters

K

K extends string

Parameters

name

K

value

any

Returns

FilterExpr

not

not: (arg) => FilterExpr

The filter does not hold.

Parameters

arg

FilterExpr

Returns

FilterExpr

now

now: () => FilterValue

The current time, as a value to compare with: now().

Returns

FilterValue

or

or: (…args) => FilterExpr

At least one filter holds; one filter is returned as it is, none throws.

Parameters

args

…FilterExpr[]

Returns

FilterExpr

present

present: <K>(name) => FilterExpr

The field has a value, a JSON field one other than null: field:*.

Type Parameters

K

K extends string

Parameters

name

K

Returns

FilterExpr

regex

regex: <K>(name, pattern) => FilterExpr

The text field matches the regular expression, ignoring case: regex(field, "pattern").

Type Parameters

K

K extends string

Parameters

name

K

pattern

string

Returns

FilterExpr

search

search: (text) => FilterExpr

Every word of the text appears, ignoring case, in one of the resource’s search fields: search("text").

Parameters

text

string

Returns

FilterExpr

similar

similar: <K>(name, text) => FilterExpr

The text field is close to the text by trigram similarity, typos included: similar(field, "text").

Type Parameters

K

K extends string

Parameters

name

K

text

string

Returns

FilterExpr

Example

where.and(where.eq('status', 'paid'), where.gte('created_at', where.ago('30d')))