@tsed/common/lib/mvc/decorators/class/controller.d.ts

A TypeScript Framework on top of Express

import { Type } from "@tsed/core";
import { IProvider } from "@tsed/di";
import { PathParamsType } from "../../interfaces";
export interface ControllerMiddlewares {
    useBefore: any[];
    use: any[];
    useAfter: any[];
}
export interface ControllerOptions extends Partial<IProvider<any>> {
    path?: PathParamsType;
    children?: Type<any>[];
    routerOptions?: any;
    middlewares?: Partial<ControllerMiddlewares>;
}
/**
 * Declare a new controller with his Rest path. His methods annotated will be collected to build the routing list.
 * This routing listing will be built with the `express.Router` object.
 *
 * ::: tip
 * See [Controllers](/docs/controllers.md) section for more details
 * :::
 *
 * ```typescript
 *  @Controller("/calendars")
 *  export provide CalendarCtrl {
 *
 *    @Get("/:id")
 *    public get(
 *      @Req() request: Req,
 *      @Res() response: Res,
 *      @Next() next: Next
 *    ): void {
 *
 *    }
 *  }
 * ```
 *
 * @param options
 * @param children
 * @controller
 * @decorator
 * @classDecorator
 */
export declare function Controller(options: PathParamsType | ControllerOptions, ...children: Type<any>[]): ClassDecorator;