QueryBuilderState

src/types/query-builder-state.type.tstype

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

Property	Type	Description
baseUrl	string	The base URL to prepend to generated URIs
embedded	Embedded	Embedded-resource selection (PostgREST only)
fields	Fields	Per-model field selection (Spatie only)
filters	Filters	Simple key-value filters (Spatie and NestJS)
includes	string[]	Related models to include (Spatie only)
isLastPageKnown	boolean	Whether the last paginated response has synced lastPage into state
lastPage	number	Last page number known from the most recent paginated response; only meaningful when isLastPageKnown is true
limit	number	Number of items per page (all drivers)
operatorFilters	OperatorFilter[]	Filters with explicit operators (NestJS only)
page	number	Current page number (all drivers)
resource	string	The API resource name for URI generation (all drivers)
search	string	Full-text search term (NestJS only)
select	string[]	Flat field selection (NestJS only)
sorts	Sort[]	Sort configurations (Spatie and NestJS)