optiovoluptas/dist/ControllerLoader.d.ts

Define Express routes using TypeScript decorators

/// <reference types="express" />
import {Application} from "express";
/**
 * Class for loading controller definitions into your Express app
 */
export declare class ControllerLoader {
    private readonly app;
    /**
     * Constructor
     * @param {Application} app Reference to your Express app
     */
    constructor(app: Application);
    /**
     * Load a controller
     * @param controllerClass The controller class
     * @param {boolean} clean See {@link parseController}
     */
    loadController(controllerClass: any, clean?: boolean): void;
    /**
     * Load controller classes from the given directories. The classes will be {@link parseController cleaned}.
     * Each file must export only the controller, i.e.
     * <code>
     * class MyController {}
     * export = MyController;
     * </code>
     * @param {string} globs Glob patterns to load from
     */
    loadDirectories(...globs: string[]): void;
    /**
     * Load controller classes from the given directories.
     * Each file must export only the controller, i.e.
     * <code>
     * class MyController {}
     * export = MyController;
     * </code>
     * @param {boolean} clean See {@link parseController}
     * @param {string} globs Glob patterns to load from
     */
    loadDirectories(clean: boolean, ...globs: string[]): void;
}