PlatformHandler

@tsed/platform-http

Usage

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

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

Overview

class PlatformHandler {
    protected responseFilter: PlatformResponseFilter;
    protected platformParams: PlatformParams;
    protected platformExceptions: PlatformExceptions;
    protected platformApplication: PlatformApplication<any>;
    protected platformMiddlewaresChain: PlatformMiddlewaresChain;
    protected platformRouters: PlatformRouters;
    constructor();
    createHandler(handlerMetadata: PlatformHandlerMetadata): any;
    createCustomHandler(provider: Provider, propertyKey: string): any;
    onRequest(handler: PlatformParamsCallback, $ctx: PlatformContext): Promise<any>;
    onResponse({ status, data, headers }: AnyPromiseResult, $ctx: PlatformContext): void;
    flush($ctx: PlatformContext): Promise<void>;
}

Description

Platform Handler abstraction layer. Wrap original class method to a pure platform handler (Express, Koa, etc...).

protected responseFilter

protected responseFilter: PlatformResponseFilter;

protected platformParams

protected platformParams: PlatformParams;

protected platformExceptions

protected platformExceptions: PlatformExceptions;

protected platformApplication

protected platformApplication: PlatformApplication<any>;

protected platformMiddlewaresChain

protected platformMiddlewaresChain: PlatformMiddlewaresChain;

protected platformRouters

protected platformRouters: PlatformRouters;

createHandler

createHandler(handlerMetadata: PlatformHandlerMetadata): any;

createCustomHandler

createCustomHandler(provider: Provider, propertyKey: string): any;

onRequest

onRequest(handler: PlatformParamsCallback, $ctx: PlatformContext): Promise<any>;

Call handler when a request his handle

onResponse

onResponse({ status, data, headers }: AnyPromiseResult, $ctx: PlatformContext): void;

flush

flush($ctx: PlatformContext): Promise<void>;

Send the response to the consumer.