IQueryBuilderState
Defined in: src/lib/interfaces/query-builder-state.interface.ts:13
Represents the complete query builder state
This is a superset that covers the needs of all drivers. Each driver reads only the fields it needs from this state.
Properties
baseUrl
baseUrl:
string
Defined in: src/lib/interfaces/query-builder-state.interface.ts:15
The base URL to prepend to generated URIs
embedded
embedded:
Embedded
Defined in: src/lib/interfaces/query-builder-state.interface.ts:17
Embedded-resource selection (PostgREST only)
fields
fields:
IFields
Defined in: src/lib/interfaces/query-builder-state.interface.ts:19
Per-model field selection (Spatie only)
filters
filters:
IFilters
Defined in: src/lib/interfaces/query-builder-state.interface.ts:21
Simple key-value filters (Spatie and NestJS)
includes
includes:
string[]
Defined in: src/lib/interfaces/query-builder-state.interface.ts:23
Related models to include (Spatie only)
isLastPageKnown
isLastPageKnown:
boolean
Defined in: src/lib/interfaces/query-builder-state.interface.ts:25
Whether the last paginated response has synced lastPage into state
lastPage
lastPage:
number
Defined in: src/lib/interfaces/query-builder-state.interface.ts:27
Last page number known from the most recent paginated response; only meaningful when isLastPageKnown is true
limit
limit:
number
Defined in: src/lib/interfaces/query-builder-state.interface.ts:29
Number of items per page (all drivers)
operatorFilters
operatorFilters:
IOperatorFilter[]
Defined in: src/lib/interfaces/query-builder-state.interface.ts:31
Filters with explicit operators (NestJS only)
page
page:
number
Defined in: src/lib/interfaces/query-builder-state.interface.ts:33
Current page number (all drivers)
resource
resource:
string
Defined in: src/lib/interfaces/query-builder-state.interface.ts:35
The API resource name for URI generation (all drivers)
search
search:
string
Defined in: src/lib/interfaces/query-builder-state.interface.ts:37
Full-text search term (NestJS only)
select
select:
string[]
Defined in: src/lib/interfaces/query-builder-state.interface.ts:39
Flat field selection (NestJS only)
sorts
sorts:
ISort[]
Defined in: src/lib/interfaces/query-builder-state.interface.ts:41
Sort configurations (Spatie and NestJS)