π API Reference β
Everything exported from the package root is public API.
ts
import {
ApiPaginatedResponse,
PageOptionsDTO,
PaginatedDTO,
QueryDTO,
QueryService,
parseQueryObject,
serializeDecimalValues,
} from '@querry-kit/nest-prisma-query';π€ Root Exports β
| Export | Kind | Description |
|---|---|---|
QueryService | Class | Generic read/query service for Prisma-compatible delegates. |
QueryServiceOptions | Type | Optional subject, access resolver, and error logger. |
AccessibleWhereResolver | Type | App-provided resolver for access-control filters. |
BaseDelegate | Type | Minimal delegate method contract. |
BaseDelegateTypeMap | Type | Prisma model type-map shape. |
DelegateTypeMap | Type | Normalized query option type-map. |
QueryOptionsMap | Type | DTO map consumed by QueryService. |
FindOneDTO | DTO | Query DTO for findOne. |
FindManyDTO | DTO | Query DTO for findMany. |
FindByIdDTO | DTO | Query DTO for findById. |
FindUniqueDTO | DTO | Query DTO for findUnique. |
AggregateDTO | DTO | Query DTO for aggregate. |
CountDTO | DTO | Query DTO for count. |
QueryDTO | DTO | Paginated resource query DTO. |
PageOptionsDTO | DTO | page and perPage request options. |
PageMetaDTO | DTO | Pagination metadata response DTO. |
PaginatedDTO | DTO | Paginated response DTO. |
Paginated | Type | Generic paginated result type. |
ApiPaginatedResponse | Decorator | Swagger response decorator for paginated DTOs. |
parseQueryObject | Function | Wrapper around @querry-kit/nest-util/object parsing for Prisma query-service call sites. |
serializeDecimalValues | Function | Prisma-result wrapper around @querry-kit/nest-util/object Decimal-like value serialization. |
π§ Subpaths β
ts
import { createCaslAccessibleWhere } from '@querry-kit/nest-prisma-query/casl';
import { QueryDTO } from '@querry-kit/nest-prisma-query/dto';
import { PageOptionsDTO } from '@querry-kit/nest-prisma-query/pagination';
import { QueryService } from '@querry-kit/nest-prisma-query/query-service';
import { ApiPaginatedResponse } from '@querry-kit/nest-prisma-query/swagger';
import { parseQueryObject } from '@querry-kit/nest-prisma-query/utils';π§© QueryService β
QueryService exposes findOne, findMany, findById, findUnique, aggregate, count, and query.
The service parses query objects before forwarding them to the delegate. Parsing is delegated to @querry-kit/nest-util/object, so dotted keys become nested objects and string primitives become booleans, numbers, nulls, arrays, or objects where safe.
See QueryService for method examples and DTOs and Pagination for request/response DTOs.
π CASL β
The ./casl subpath exports createCaslAccessibleWhere and CaslAccessibleWhereOptions.
See CASL for a relation-based access example.