ts5deco-express-controller
Version:
TypeScript 5 Modern Decorator Express Controller Framework
54 lines • 1.85 kB
TypeScript
import { Router } from 'express';
import { ControllerConstructor } from './types';
/**
* 컨트롤러에서 Express Router를 생성합니다
*
* @param controllers - 등록할 컨트롤러 클래스들
* @returns Express Router 인스턴스
*
* @example
* ```typescript
* import { createRouter } from 'ts5deco-express-controller';
* import { UserController, PostController } from './controllers';
*
* const router = createRouter([UserController, PostController]);
* app.use('/api', router);
* ```
*/
export declare function createRouter(controllers: ControllerConstructor[]): Router;
/**
* 단일 컨트롤러를 라우터에 등록합니다
*
* @param router - Express Router 인스턴스
* @param ControllerClass - 등록할 컨트롤러 클래스
*
* @example
* ```typescript
* import { registerController } from 'ts5deco-express-controller';
* import { UserController } from './controllers/user.controller';
*
* const router = Router();
* registerController(router, UserController);
* app.use('/api', router);
* ```
*/
export declare function registerController(router: Router, ControllerClass: ControllerConstructor): void;
/**
* Express 앱에 컨트롤러들을 등록하는 헬퍼 함수
*
* @param app - Express 앱 인스턴스
* @param controllers - 등록할 컨트롤러 클래스들
* @param basePath - 기본 경로 (기본값: '')
*
* @example
* ```typescript
* import express from 'express';
* import { registerControllers } from 'ts5deco-express-controller';
* import { UserController, PostController } from './controllers';
*
* const app = express();
* registerControllers(app, [UserController, PostController], '/api');
* ```
*/
export declare function registerControllers(app: any, controllers: ControllerConstructor[], basePath?: string): void;
//# sourceMappingURL=router.d.ts.map