Class Filter<T>

Filter builder class that provides methods for creating SQL WHERE clause conditions. All methods return branded FilterCondition strings that can be combined with logical operators.

Type Parameters

T = Record<string, string | number>

Index

Constructors

Methods

and contains endsWith eq escape exists finalize glob mustEscape notExists notOneOf oneOf or startsWith

Constructors

constructor

new Filter<T = Record<string, string | number>>(): Filter<T>
Type Parameters
- T = Record<string, string | number>
Returns Filter<T>

Methods

and

and(...conditions: FilterCondition[]): FilterCondition
Combines multiple filter conditions with AND logic.
Parameters
- ...conditions: FilterCondition[]
Returns FilterCondition
- Defined in src/query.ts:579

contains

contains(field: Extract<keyof T, string>, value: string): FilterCondition
Creates a LIKE condition for matching strings that contain the given value. Automatically handles SQL wildcard character escaping.
Parameters
- field: Extract<keyof T, string>
- value: string
Returns FilterCondition
- Defined in src/query.ts:626

endsWith

endsWith(field: Extract<keyof T, string>, value: string): FilterCondition
Creates a LIKE condition for matching strings that end with the given value. Automatically handles SQL wildcard character escaping.
Parameters
- field: Extract<keyof T, string>
- value: string
Returns FilterCondition
- Defined in src/query.ts:614

eq

eq<K extends string>(field: K, value: T[K]): FilterCondition
Creates an equality condition for exact value matching.
Type Parameters
- K extends string
Parameters
- field: K
- value: T[K]
Returns FilterCondition
- Defined in src/query.ts:594

`Protected`escape

escape(value: string): string
Escapes SQL wildcard characters in a string value.
Parameters
- value: string
Returns string
- Defined in src/query.ts:688

exists

exists(field: Extract<keyof T, string>): FilterCondition
Creates an IS NOT NULL condition to check if a field has a value.
Parameters
- field: Extract<keyof T, string>
Returns FilterCondition
- Defined in src/query.ts:658

`Protected`finalize

finalize(value: string, escape: boolean): FilterCondition
Finalizes a LIKE condition by adding ESCAPE clause if needed.
Parameters
- value: string
- escape: boolean
Returns FilterCondition
- Defined in src/query.ts:696

glob

glob(field: Extract<keyof T, string>, value: string): FilterCondition
Creates a GLOB condition for pattern matching using Unix shell-style wildcards.
Parameters
- field: Extract<keyof T, string>
- value: string
Returns FilterCondition
- Defined in src/query.ts:672

`Protected`mustEscape

mustEscape(value: string): boolean
Checks if a string value contains SQL wildcard characters that need escaping.
Parameters
- value: string
Returns boolean
- Defined in src/query.ts:679

notExists

notExists(field: Extract<keyof T, string>): FilterCondition
Creates an IS NULL condition to check if a field is null.
Parameters
- field: Extract<keyof T, string>
Returns FilterCondition
- Defined in src/query.ts:665

notOneOf

notOneOf<K extends string>(field: K, ...values: T[K][]): FilterCondition
Creates a NOT IN condition for excluding any of the provided values.
Type Parameters
- K extends string
Parameters
- field: K
- ...values: T[K][]
Returns FilterCondition
- Defined in src/query.ts:651

oneOf

oneOf<K extends string>(field: K, ...values: T[K][]): FilterCondition
Creates an IN condition for matching any of the provided values. Automatically handles string quoting for string values.
Type Parameters
- K extends string
Parameters
- field: K
- ...values: T[K][]
Returns FilterCondition
- Defined in src/query.ts:638

or

or(...conditions: FilterCondition[]): FilterCondition
Combines multiple filter conditions with OR logic. Automatically wraps the result in parentheses.
Parameters
- ...conditions: FilterCondition[]
Returns FilterCondition
- Defined in src/query.ts:587

startsWith

startsWith(field: Extract<keyof T, string>, value: string): FilterCondition
Creates a LIKE condition for matching strings that start with the given value. Automatically handles SQL wildcard character escaping.
Parameters
- field: Extract<keyof T, string>
- value: string
Returns FilterCondition
- Defined in src/query.ts:602