@elsikora/nestjs-crud-automator/dist/cjs/utility/api/controller/write-dto-swagger.utility.d.ts

A library for automating the creation of CRUD operations in NestJS.

import type { EApiRouteType } from '../../../enum/decorator/api/index';
import type { IApiControllerProperties } from '../../../interface/decorator/api/index';
import type { IApiEntity } from '../../../interface/entity/index';
import type { TApiControllerPropertiesRoute } from '../../../type/decorator/api/controller/index';
/**
 * Generates and registers Swagger documentation for DTOs.
 * Creates or uses existing DTOs for request, query, body, and response,
 * and ensures they're properly registered with Swagger for API documentation.
 * @param {object} target - The target controller class
 * @param {IApiEntity<E>} entity - The entity definition
 * @param {IApiControllerProperties<E>} properties - Controller configuration properties
 * @param {EApiRouteType} method - The type of route (CREATE, DELETE, GET, etc.)
 * @param {TApiControllerPropertiesRoute<E, typeof method>} routeConfig - Route-specific configuration
 * @param {IApiEntity<E>} entityMetadata - The entity metadata containing column information
 * @returns {void}
 * @template E - The entity type
 */
export declare function ApiControllerWriteDtoSwagger<E>(target: object, entity: IApiEntity<E>, properties: IApiControllerProperties<E>, method: EApiRouteType, routeConfig: TApiControllerPropertiesRoute<E, typeof method>, entityMetadata: IApiEntity<E>): void;