PlatformContext

@tsed/platform-http

Usage

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

See /packages/platform/platform-http/src/types/common/domain/PlatformContext.ts.

Overview

class PlatformContext<PReq extends PlatformRequest = PlatformRequest, PRes extends PlatformResponse = PlatformResponse> extends DIContext {
    readonly PLATFORM: string;
    event: IncomingEvent;
    data: any;
    error?: unknown;
    next?: any;
    readonly response: PRes;
    readonly request: PReq;
    endpoint: EndpointMetadata;
    handlerMetadata: PlatformHandlerMetadata;
    constructor(options: PlatformContextOptions);
    get url(): string;
    get app(): PlatformApplication<TsED.Application>;
    start(): Promise<void>;
    finish(): Promise<void>;
    isFinished(): boolean;
    isDone(): any;
    getRequest<Req = any>(): Req;
    getResponse<Res = any>(): Res;
    getReq(): IncomingMessage;
    getRes(): ServerResponse;
    getApp<T = any>(): T;
}

readonly PLATFORM

readonly PLATFORM: string;

event

event: IncomingEvent;

data

data: any;

The data return by the previous endpoint if you use multiple handler on the same route. By default data is empty.

error

error?: unknown;

The error caught by the current handler

next

next?: any;

readonly response

readonly response: PRes;

The current PlatformResponse.

readonly request

readonly request: PReq;

The current PlatformRequest.

endpoint

endpoint: EndpointMetadata;

The current EndpointMetadata resolved by Ts.ED during the request.

handlerMetadata

handlerMetadata: PlatformHandlerMetadata;

The current PlatformHandlerMetadata resolved by Ts.ED during the request.

get url

get url(): string;

get app

get app(): PlatformApplication<TsED.Application>;

start

start(): Promise<void>;

finish

finish(): Promise<void>;

isFinished

isFinished(): boolean;

isDone

isDone(): any;

getRequest

getRequest<Req = any>(): Req;

Return the framework request instance (Express, Koa, etc...)

getResponse

getResponse<Res = any>(): Res;

Return the framework response instance (Express, Koa, etc...)

getReq

getReq(): IncomingMessage;

Get Node.js request

getRes

getRes(): ServerResponse;

Get Node.js response

getApp

getApp<T = any>(): T;

Return the original application instance.