PlatformExpressSettings

@tsed/platform-express

Usage

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

See /packages/platform/platform-express/src/interfaces/PlatformExpressSettings.ts.

Overview

interface PlatformExpressSettings {
    version?: "v4" | "v5";
    router?: RouterOptions;
    app?: Express.Application;
    bodyParser?: {
        json?: ((opts?: OptionsJson) => NextHandleFunction) | OptionsJson;
        text?: ((opts?: OptionsText) => NextHandleFunction) | OptionsText;
        raw?: ((opts?: Options) => NextHandleFunction) | Options;
        urlencoded?: ((opts?: OptionsUrlencoded) => NextHandleFunction) | OptionsUrlencoded;
    };
    useRawBody?: boolean;
}

version

version?: "v4" | "v5";

Force Express version detection. Use when Ts.ED doesn't detect the version automatically.

router

router?: RouterOptions;

Global configuration for the Express.Router. See express documentation.

app

app?: Express.Application;

Express application

bodyParser

bodyParser?: {
     json?: ((opts?: OptionsJson) => NextHandleFunction) | OptionsJson;
     text?: ((opts?: OptionsText) => NextHandleFunction) | OptionsText;
     raw?: ((opts?: Options) => NextHandleFunction) | Options;
     urlencoded?: ((opts?: OptionsUrlencoded) => NextHandleFunction) | OptionsUrlencoded;
 };

body parser configuration

useRawBody

useRawBody?: boolean;