PlatformResponseFilter

@tsed/platform-response-filter

Usage

import { PlatformResponseFilter } from "@tsed/platform-response-filter";

See /packages/platform/platform-response-filter/src/types/services/PlatformResponseFilter.ts.

Overview

class PlatformResponseFilter {
    protected additionalProperties: boolean | undefined;
    protected container: {
        contentTypes: string[];
        resolve(bestContentType: string): import("../index.js").ResponseFilterMethods<unknown> | undefined;
    };
    protected contentTypeResolver: (data: any, ctx: BaseContext) => any;
    transform(data: unknown, $ctx: BaseContext): Promise<unknown>;
    protected renderView(data: unknown, $ctx: BaseContext): Promise<any>;
    protected serialize(data: unknown, ctx: BaseContext): Promise<unknown>;
    protected resolve(data: any, ctx: BaseContext): any;
    protected getIncludes(ctx: BaseContext): string[] | undefined;
}

Description

PlatformResponseFilter is responsible for transforming the response data to the appropriate format based on the endpoint metadata and context.

protected additionalProperties

protected additionalProperties: boolean | undefined;

protected container

protected container: {
     contentTypes: string[];
     resolve(bestContentType: string): import("../index.js").ResponseFilterMethods<unknown> | undefined;
 };

protected contentTypeResolver:

protected contentTypeResolver: (data: any, ctx: BaseContext) => any;

transform

transform(data: unknown, $ctx: BaseContext): Promise<unknown>;

• data (unknown): The data to transform.

• $ctx (``): The context.

Transform the data to the right format.

protected renderView

protected renderView(data: unknown, $ctx: BaseContext): Promise<any>;

• data (unknown): The data to render.

• $ctx (``): The context.

Render the view with the given data.

protected serialize

protected serialize(data: unknown, ctx: BaseContext): Promise<unknown>;

Serialize data before calling filters

protected resolve

protected resolve(data: any, ctx: BaseContext): any;

protected getIncludes

protected getIncludes(ctx: BaseContext): string[] | undefined;