IQueryBuilderConfig

Defined in: src/lib/interfaces/query-builder-config.interface.ts:7

Configuration interface for customizing request query parameter key names

Each property maps a logical query concept to the actual query parameter name used in the generated URI. The defaults depend on the selected driver.

Properties

appends?

optional appends?: string

Defined in: src/lib/interfaces/query-builder-config.interface.ts:9

Key for the appends parameter (Laravel only, default: 'append')

---

fields?

optional fields?: string

Defined in: src/lib/interfaces/query-builder-config.interface.ts:11

Key for the fields parameter (Laravel: 'fields', NestJS: 'select')

---

filters?

optional filters?: string

Defined in: src/lib/interfaces/query-builder-config.interface.ts:13

Key for the filters parameter (default: 'filter')

---

includes?

optional includes?: string

Defined in: src/lib/interfaces/query-builder-config.interface.ts:15

Key for the includes parameter (Laravel only, default: 'include')

---

limit?

optional limit?: string

Defined in: src/lib/interfaces/query-builder-config.interface.ts:17

Key for the limit parameter (default: 'limit')

---

page?

optional page?: string

Defined in: src/lib/interfaces/query-builder-config.interface.ts:19

Key for the page parameter (default: 'page')

---

search?

optional search?: string

Defined in: src/lib/interfaces/query-builder-config.interface.ts:21

Key for the search parameter (NestJS only, default: 'search')

---

select?

optional select?: string

Defined in: src/lib/interfaces/query-builder-config.interface.ts:23

Key for the select parameter (NestJS only, default: 'select')

---

sort?

optional sort?: string

Defined in: src/lib/interfaces/query-builder-config.interface.ts:25

Key for the sort parameter (Laravel: 'sort', NestJS: 'sortBy')

---

sortBy?

optional sortBy?: string

Defined in: src/lib/interfaces/query-builder-config.interface.ts:27

Key for the sortBy parameter (NestJS only, default: 'sortBy')