Skip to content

API Reference

@querry-kit/nest-util exports a small public API from the package root.

ts
import {
  ApiErrorResponses,
  ApiPaginatedResponse,
  ApiParamId,
  ApiPropertyId,
  EmptyStringToNullPipe,
  QueryTransformPipe,
  ValidationUtil,
} from '@querry-kit/nest-util';

import { diffObjects, hasObjectDifferences, parseObject } from '@querry-kit/nest-util/object';

Exports

ExportKindDescription
QueryTransformPipeClassNestJS pipe that normalizes query parameter objects.
EmptyStringToNullPipeClassNestJS pipe that trims body strings and maps blank strings to null.
ApiParamIdDecoratorSwagger decorator for UUID route parameters.
ApiPropertyIdDecoratorSwagger decorator for DTO ID properties.
ApiPropertyCreatedAtDecoratorSwagger decorator for created-at DTO properties.
ApiPropertyUpdatedAtDecoratorSwagger decorator for updated-at DTO properties.
ApiPaginatedResponseDecoratorSwagger decorator for paginated response schemas.
ApiErrorResponsesDecoratorSwagger decorator for common error response schemas.
parseObjectFunctionParses query-like values into JavaScript primitives and nested objects.
diffObjectsFunctionBuilds nested old/new diff objects.
serializeDecimalValuesFunctionRecursively serializes Decimal-like object values to numbers.
hasObjectDifferencesFunctionChecks recursively if two values differ.
ValidationUtilClassMaps class-validator errors into nested object shapes.
isObjectFunctionChecks if typeof value === 'object'.
isNumberFunctionChecks if a value is or can be converted to a number.
isBooleanFunctionChecks if a value is boolean-like.
isPlainObjectFunctionChecks if a value is a non-array object and not null.

Reference Pages

Released under the MIT License.