PlatformAdapter

@tsed/platform-http

Usage

import { PlatformAdapter } from "@tsed/platform-http";

See /packages/platform/platform-http/src/types/common/services/PlatformAdapter.ts.

Overview

abstract class PlatformAdapter<App = TsED.Application> {
    abstract readonly NAME: string;
    providers: ProviderOpts[];
    get app(): PlatformApplication<App>;
    getServers(): CreateServerReturn[];
    onInit(): Promise<void> | void;
    beforeLoadRoutes(): Promise<void> | void;
    afterLoadRoutes(): Promise<void> | void;
    abstract useContext(): Promise<void> | void;
    abstract mapLayers(layer: PlatformLayer[]): void;
    mapHandler(handler: Function, layer: PlatformHandlerMetadata): Function;
    abstract createApp(): {
        app: App;
        callback(): (req: IncomingMessage, res: ServerResponse) => void;
    };
    abstract statics(endpoint: string, options: PlatformStaticsOptions): any;
    abstract multipart(options: PlatformMulterSettings): PlatformMulter;
    abstract bodyParser(type: string, opts?: Record<string, any>): any;
}

abstract readonly NAME

abstract readonly NAME: string;

providers

providers: ProviderOpts[];

Load providers in top priority

get app

get app(): PlatformApplication<App>;

getServers

getServers(): CreateServerReturn[];

onInit

onInit(): Promise<void> | void;

beforeLoadRoutes

beforeLoadRoutes(): Promise<void> | void;

afterLoadRoutes

afterLoadRoutes(): Promise<void> | void;

abstract useContext

abstract useContext(): Promise<void> | void;

create initial context

abstract mapLayers

abstract mapLayers(layer: PlatformLayer[]): void;

Map router layer to the targeted framework

mapHandler

mapHandler(handler: Function, layer: PlatformHandlerMetadata): Function;

Map handler to the targeted framework

abstract createApp

abstract createApp(): {
     app: App;
     callback(): (req: IncomingMessage, res: ServerResponse) => void;
 };

Return the app instance

abstract statics

abstract statics(endpoint: string, options: PlatformStaticsOptions): any;

Return the statics middlewares

abstract multipart

abstract multipart(options: PlatformMulterSettings): PlatformMulter;

Return the multipart middleware

abstract bodyParser

abstract bodyParser(type: string, opts?: Record<string, any>): any;

Return the body parser for the given