@elsikora/nestjs-crud-automator
Version:
A library for automating the creation of CRUD operations in NestJS.
16 lines (15 loc) • 890 B
TypeScript
import { EApiRouteType } from '../../../enum/decorator/api';
import { IApiRouteDocumentationProperties } from '../../../interface/decorator/api/route/documentation-properties.interface';
/**
* Builds default Swagger documentation for generated CRUD routes.
* @param {object} options - Route documentation inputs.
* @param {IApiRouteDocumentationProperties} [options.documentation] - User-provided overrides.
* @param {string} options.resourceName - Human-friendly resource name represented by the route.
* @param {EApiRouteType} options.routeType - Generated CRUD route type.
* @returns {IApiRouteDocumentationProperties} Documentation metadata for ApiMethod.
*/
export declare function ApiControllerBuildRouteDocumentation(options: {
documentation?: IApiRouteDocumentationProperties;
resourceName: string;
routeType: EApiRouteType;
}): IApiRouteDocumentationProperties;