@nestjs-crud/request
v2.2.1
Published
NestJs CRUD for RESTful APIs - request query builder
Downloads
1,275
Maintainers
Readme
Install
npm i @nestjs-crud/requestUsage
@nestjs-crud/request provides:
RequestQueryBuilder— frontend helper to construct?filter=,?sort=,?join=,?search=,?fields=,?limit=,?offset=query strings.RequestQueryParser— backend helper to parse those query strings back into a structuredParsedRequestParamsobject the adapter services consume.
import { RequestQueryBuilder } from '@nestjs-crud/request';
const qs = RequestQueryBuilder.create()
.setFilter({ field: 'status', operator: 'eq', value: 'active' })
.sortBy({ field: 'createdAt', order: 'DESC' })
.setLimit(20)
.query();
// qs === 'filter=status||$eq||active&sort=createdAt,DESC&limit=20'
fetch(`/api/users?${qs}`);The parser side is wired automatically by @nestjs-crud/core's CrudRequestInterceptor — most backend consumers don't need to call it directly.
See also
- Wiki: Requests — full query-string syntax (search conditions, operators, joins, etc.)
- @nestjs-crud/core — consumes the parser
- v2 Migration guide
