PlatformExpress

@tsed/platform-express

Usage

import { PlatformExpress } from "@tsed/platform-express";

See /packages/platform/platform-express/src/types/components/PlatformExpress.ts.

Overview

class PlatformExpress extends PlatformAdapter<Express.Application> {
    readonly NAME = "express";
    readonly providers: ({
        token: typeof PlatformHandler;
        useClass: typeof PlatformExpressHandler;
    } | {
        token: typeof PlatformResponse;
        useClass?: undefined;
    } | {
        token: typeof PlatformRequest;
        useClass?: undefined;
    } | {
        token: typeof PlatformApplication;
        useClass?: undefined;
    } | {
        token: typeof Platform;
        useClass?: undefined;
    })[];
    constructor();
    static create(module: Type<any>, settings?: Partial<TsED.Configuration>): PlatformBuilder<TsED.Application>;
    static bootstrap(module: Type<any>, settings?: Partial<TsED.Configuration>): Promise<PlatformBuilder<TsED.Application>>;
    beforeLoadRoutes(): Promise<void>;
    afterLoadRoutes(): Promise<void>;
    mapLayers(layers: PlatformLayer[]): void;
    mapHandler(handler: Function, metadata: PlatformHandlerMetadata): (error: unknown, req: any, res: any, next: any) => Promise<Promise<any>>;
    useContext(): void;
    createApp(): {
        app: Express.Express;
        callback: () => Express.Express;
    };
    multipart(options: PlatformMulterSettings): PlatformMulter;
    statics(endpoint: string, options: PlatformStaticsOptions): (request: any, response: any, next: any) => void;
    bodyParser(type: "json" | "text" | "urlencoded", additionalOptions?: any): any;
}

readonly NAME

readonly NAME = "express";

readonly providers:

readonly providers: ({
     token: typeof PlatformHandler;
     useClass: typeof PlatformExpressHandler;
 } | {
     token: typeof PlatformResponse;
     useClass?: undefined;
 } | {
     token: typeof PlatformRequest;
     useClass?: undefined;
 } | {
     token: typeof PlatformApplication;
     useClass?: undefined;
 } | {
     token: typeof Platform;
     useClass?: undefined;
 })[];

static create

static create(module: Type<any>, settings?: Partial<TsED.Configuration>): PlatformBuilder<TsED.Application>;

Create new serverless application. In this mode, the component scan are disabled.

static bootstrap

static bootstrap(module: Type<any>, settings?: Partial<TsED.Configuration>): Promise<PlatformBuilder<TsED.Application>>;

Bootstrap a server application

beforeLoadRoutes

beforeLoadRoutes(): Promise<void>;

afterLoadRoutes

afterLoadRoutes(): Promise<void>;

mapLayers

mapLayers(layers: PlatformLayer[]): void;

mapHandler

mapHandler(handler: Function, metadata: PlatformHandlerMetadata): (error: unknown, req: any, res: any, next: any) => Promise<Promise<any>>;

useContext

useContext(): void;

createApp

createApp(): {
     app: Express.Express;
     callback: () => Express.Express;
 };

multipart

multipart(options: PlatformMulterSettings): PlatformMulter;

statics

statics(endpoint: string, options: PlatformStaticsOptions): (request: any, response: any, next: any) => void;

bodyParser

bodyParser(type: "json" | "text" | "urlencoded", additionalOptions?: any): any;