PlatformKoaResponse

@tsed/platform-koa

Usage

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

See /packages/platform/platform-koa/src/services/PlatformKoaResponse.ts.

Overview

class PlatformKoaResponse extends PlatformResponse<Koa.Response> {
    get ctx(): Koa.Context;
    get statusCode(): number;
    get locals(): Koa.DefaultState;
    getRes(): ServerResponse;
    hasStatus(): boolean;
    status(status: number): this;
    contentType(contentType: string): this;
    getHeaders(): import("http").OutgoingHttpHeaders;
    stream(data: any): this;
    getBody(): any;
    cookie(name: string, value: string | null, opts?: TsED.SetCookieOpts): this;
    protected json(data: any): this;
    protected buffer(data: Buffer): this;
    protected end(data?: string | Buffer): void;
}

get ctx

get ctx(): Koa.Context;

get statusCode

get statusCode(): number;

get locals

get locals(): Koa.DefaultState;

getRes

getRes(): ServerResponse;

Return the Node.js response object

hasStatus

hasStatus(): boolean;

status

status(status: number): this;

Sets the HTTP status for the response.

contentType

contentType(contentType: string): this;

Set Content-Type response header with type through mime.lookup() when it does not contain "/", or set the Content-Type to type otherwise.

Examples:

res.type('.html');
res.type('html');
res.type('json');
res.type('application/json');
res.type('png');

getHeaders

getHeaders(): import("http").OutgoingHttpHeaders;

stream

stream(data: any): this;

getBody

getBody(): any;

cookie

cookie(name: string, value: string | null, opts?: TsED.SetCookieOpts): this;

protected json

protected json(data: any): this;

protected buffer

protected buffer(data: Buffer): this;

protected end

protected end(data?: string | Buffer): void;