@elsikora/nestjs-crud-automator
Version:
A library for automating the creation of CRUD operations in NestJS.
18 lines (17 loc) • 1.31 kB
TypeScript
import { IApiControllerIdentityPlan } from '../../../interface/class/api/controller/identity-plan.interface';
import { IApiControllerReadPlan } from '../../../interface/class/api/controller/read';
import { IApiControllerPropertiesRouteAutoDtoConfig } from '../../../interface/decorator/api';
import { IApiEntity } from '../../../interface/entity';
import { Type } from '@nestjs/common';
import { IAuthGuard } from '@nestjs/passport';
/**
* Generates a PARAMETERS DTO for a GET identity alias and optional inherited read scope.
* @param {IApiEntity<E>} entityMetadata - Entity metadata supplying field decorators.
* @param {IApiControllerIdentityPlan} identityPlan - Compiled identity alias plan.
* @param {IApiControllerReadPlan} [readPlan] - Optional compiled owner-scope plan.
* @param {IApiControllerPropertiesRouteAutoDtoConfig} [dtoConfig] - Auto DTO validators.
* @param {Type<IAuthGuard>} [currentGuard] - Route authentication guard.
* @returns {Type<unknown>} Generated PARAMETERS DTO.
* @template E - Entity type.
*/
export declare function DtoGenerateIdentityReadParameters<E>(entityMetadata: IApiEntity<E>, identityPlan: IApiControllerIdentityPlan, readPlan?: IApiControllerReadPlan, dtoConfig?: IApiControllerPropertiesRouteAutoDtoConfig, currentGuard?: Type<IAuthGuard>): Type<unknown>;