silvie/http/server/index.d.ts

Typescript Back-end Framework

import { Request, Response } from 'express';
declare class HTTPServer {
    app: any;
    srv: any;
    upload: any;
    globalMiddlewares: string[];
    routes: any[];
    /**
     * Initialize a new HTTP Server
     */
    init(instanceCallback?: any): void;
    initCORS(): void;
    initBodyParser(): void;
    initSession(): void;
    initCookie(): void;
    initUploads(): void;
    initStatics(): void;
    initGlobalMiddlewares(): void;
    initRoutes(): void;
    initServer(): void;
    /**
     * Return express server instance
     */
    get expressServer(): any;
    /**
     * Return HTTP server instance
     */
    get server(): any;
    /**
     * Registers a route handler with some middlewares
     * @param method HTTP Verb
     * @param url Route URL
     * @param routeMiddlewares Route middlewares array
     * @param upload Upload configuration
     * @param handler Route handler
     */
    registerRoute(method: string, url: string | RegExp, routeMiddlewares: string[], upload: {
        action: string;
        options?: any;
    }, handler: (req: Request, res: Response) => void): void;
    /**
     * Registers a middleware on the whole HTTP Server
     * @param middlewareName The name middleware to register
     */
    globalMiddleware(middlewareName: string): void;
    /**
     * Starts listening on a port in this order: --port, -p, .env.APP_PORT, config.port, customPort
     */
    start(customPort?: number, customHost?: string): void;
}
declare const server: HTTPServer;
export default server;