QueryBuilderConfig

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

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

Property	Type	Description
appends	string	Key for the appends parameter (Laravel only, default: ‘append’)
fields	string	Key for the fields parameter (Laravel: ‘fields’, NestJS: ‘select’)
filters	string	Key for the filters parameter (default: ‘filter’)
includes	string	Key for the includes parameter (Laravel only, default: ‘include’)
limit	string	Key for the limit parameter (default: ‘limit’)
page	string	Key for the page parameter (default: ‘page’)
search	string	Key for the search parameter (NestJS only, default: ‘search’)
select	string	Key for the select parameter (NestJS only, default: ‘select’)
sort	string	Key for the sort parameter (Laravel: ‘sort’, NestJS: ‘sortBy’)
sortBy	string	Key for the sortBy parameter (NestJS only, default: ‘sortBy’)