API Reference

@querry-kit/nest-fields-query exports the fields API from the package root and from the ./fields subpath.

Everything exported from the package root is public API. Prefer the Fields facade in controllers; use the focused parser, validator, and projector classes when you need to test or compose individual steps.

import {
  ApiFieldsQuery,
  Fields,
  FieldsExceptionFilter,
  FieldsQuery,
  buildFieldSchemaFromDto,
  relation,
} from '@querry-kit/nest-fields-query';

import { FieldsParser, FieldsValidator } from '@querry-kit/nest-fields-query/fields';

Exports

Export	Kind	Description
Fields	Class	Facade for parsing, validation, include generation, and projection.
FieldsParser	Class	Parses raw fields query values into projection trees.
FieldsValidator	Class	Validates projection trees against field schemas and include requirements.
FieldsProjector	Class	Applies projection trees to objects and arrays.
FieldsExceptionFilter	Class	Serializes fields errors as HTTP 400 responses in NestJS.
FieldsBadRequestException	Class	NestJS BadRequestException subclass for parser and validator failures.
ApiFieldsQuery	Function	Documents the fields query parameter and invalid fields 400 response in Swagger.
FieldsQuery	Function	Resolves fields as a validated FieldsProjection in NestJS controller parameters.
buildFieldSchemaFromDto	Function	Builds a FieldSchema from Swagger DTO metadata.
getDtoFields	Function	Reads Swagger-decorated DTO field names.
relation	Function	Creates a relation schema node.
createRelationSchemaNode	Function	Creates a relation schema node with an explicit name.
FieldSchema	Type	Map of allowed field names to schema nodes.
FieldSchemaNode	Type	Scalar or relation schema node.
FieldsProjection	Type	Parsed projection tree.
FieldsParseOptions	Type	Options for Fields.parseAndValidate.
FieldsBadRequestResponse	Type	Structured response payload for invalid fields query parameters.
ApiFieldsQueryOptions	Type	Swagger metadata overrides accepted by ApiFieldsQuery.

Reference Pages

• Fields
• Fields Facade
• DTO Schema
• Errors