PlatformKoa

@tsed/platform-koa

Usage

import { PlatformKoa } from "@tsed/platform-koa";

See /packages/platform/platform-koa/src/types/components/PlatformKoa.ts.

Overview

class PlatformKoa extends PlatformAdapter<Koa> {
    readonly NAME = "koa";
    readonly providers: ({
        token: typeof PlatformResponse;
        useClass: typeof PlatformKoaResponse;
    } | {
        token: typeof PlatformRequest;
        useClass: typeof PlatformKoaRequest;
    } | {
        token: typeof PlatformHandler;
        useClass: typeof PlatformKoaHandler;
    } | {
        token: typeof PlatformApplication;
        useClass?: undefined;
    } | {
        token: typeof Platform;
        useClass?: undefined;
    })[];
    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>>;
    onInit(): void;
    mapLayers(layers: PlatformLayer[]): void;
    mapHandler(handler: Function, metadata: PlatformHandlerMetadata): (koaContext: Koa.Context, next: Koa.Next) => Promise<any>;
    useContext(): void;
    createApp(): {
        app: Koa<Koa.DefaultState, Koa.DefaultContext>;
        callback(): (req: import("http").IncomingMessage | import("http2").Http2ServerRequest, res: import("http").ServerResponse<import("http").IncomingMessage> | import("http2").Http2ServerResponse<import("http2").Http2ServerRequest>) => Promise<void>;
    };
    multipart(options: PlatformMulterSettings): PlatformMulter;
    statics(endpoint: string, options: PlatformStaticsOptions): any;
    bodyParser(_: "json" | "urlencoded" | "raw" | "text", additionalOptions?: any): any;
}

readonly NAME

readonly NAME = "koa";

readonly providers:

readonly providers: ({
     token: typeof PlatformResponse;
     useClass: typeof PlatformKoaResponse;
 } | {
     token: typeof PlatformRequest;
     useClass: typeof PlatformKoaRequest;
 } | {
     token: typeof PlatformHandler;
     useClass: typeof PlatformKoaHandler;
 } | {
     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

onInit

onInit(): void;

mapLayers

mapLayers(layers: PlatformLayer[]): void;

mapHandler

mapHandler(handler: Function, metadata: PlatformHandlerMetadata): (koaContext: Koa.Context, next: Koa.Next) => Promise<any>;

useContext

useContext(): void;

createApp

createApp(): {
     app: Koa<Koa.DefaultState, Koa.DefaultContext>;
     callback(): (req: import("http").IncomingMessage | import("http2").Http2ServerRequest, res: import("http").ServerResponse<import("http").IncomingMessage> | import("http2").Http2ServerResponse<import("http2").Http2ServerRequest>) => Promise<void>;
 };

multipart

multipart(options: PlatformMulterSettings): PlatformMulter;

statics

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

bodyParser

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