Skip to main content
Version: 3.3.0

IQueryBuilderState

Defined in: src/lib/interfaces/query-builder-state.interface.ts:12

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:14

The base URL to prepend to generated URIs

fields​

fields: IFields

Defined in: src/lib/interfaces/query-builder-state.interface.ts:16

Per-model field selection (Spatie only)

filters​

filters: IFilters

Defined in: src/lib/interfaces/query-builder-state.interface.ts:18

Simple key-value filters (Spatie and NestJS)

includes​

includes: string[]

Defined in: src/lib/interfaces/query-builder-state.interface.ts:20

Related models to include (Spatie only)

isLastPageKnown​

isLastPageKnown: boolean

Defined in: src/lib/interfaces/query-builder-state.interface.ts:22

Whether the last paginated response has synced lastPage into state

lastPage​

lastPage: number

Defined in: src/lib/interfaces/query-builder-state.interface.ts:24

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:26

Number of items per page (all drivers)

operatorFilters​

operatorFilters: IOperatorFilter[]

Defined in: src/lib/interfaces/query-builder-state.interface.ts:28

Filters with explicit operators (NestJS only)

page​

page: number

Defined in: src/lib/interfaces/query-builder-state.interface.ts:30

Current page number (all drivers)

resource​

resource: string

Defined in: src/lib/interfaces/query-builder-state.interface.ts:32

The API resource name for URI generation (all drivers)

search: string

Defined in: src/lib/interfaces/query-builder-state.interface.ts:34

Full-text search term (NestJS only)

select​

select: string[]

Defined in: src/lib/interfaces/query-builder-state.interface.ts:36

Flat field selection (NestJS only)

sorts​

sorts: ISort[]

Defined in: src/lib/interfaces/query-builder-state.interface.ts:38

Sort configurations (Spatie and NestJS)