PlatformFastify

@tsed/platform-fastify

Usage

import { PlatformFastify } from "@tsed/platform-fastify";

See /packages/platform/platform-fastify/src/components/PlatformFastify.ts.

Overview

class PlatformFastify extends PlatformAdapter<FastifyInstance> {
    readonly NAME = "fastify";
    
    static create(module: Type<any>, settings?: Partial<TsED.Configuration>): PlatformBuilder<Fastify.FastifyInstance<Fastify.RawServerDefault, Http.IncomingMessage, Http.ServerResponse<Http.IncomingMessage>, Fastify.FastifyBaseLogger, Fastify.FastifyTypeProviderDefault>>;
    static bootstrap(module: Type<any>, settings?: Partial<TsED.Configuration>): Promise<PlatformBuilder<Fastify.FastifyInstance<Fastify.RawServerDefault, Http.IncomingMessage, Http.ServerResponse<Http.IncomingMessage>, Fastify.FastifyBaseLogger, Fastify.FastifyTypeProviderDefault>>>;
    mapLayers(layers: PlatformLayer[]): Promise<void>;
    mapHandler(handler: (...args: any[]) => any, metadata: PlatformHandlerMetadata): (...args: any[]) => any;
    useContext(): Promise<void>;
    createApp(): {
        app: Fastify.FastifyInstance<Fastify.RawServerDefault, Http.IncomingMessage, Http.ServerResponse<Http.IncomingMessage>, Fastify.FastifyBaseLogger, Fastify.FastifyTypeProviderDefault>;
        callback: () => (request: IncomingMessage, response: ServerResponse) => Promise<void>;
    };
    afterLoadRoutes(): Promise<void>;
    getServers(): any[];
    bodyParser(type: string, opts: Record<string, any> | undefined): any;
    statics(endpoint: string, options: PlatformStaticsOptions & FastifyStaticOptions): Promise<void>;
    protected compose(layer: PlatformLayer, wildcard?: string): (req: FastifyRequest, _: FastifyReply) => Promise<Promise<any>>;
    protected resolvePlugins(): Promise<PlatformFastifyPluginLoadingOptions[]>;
}

readonly NAME

readonly NAME = "fastify";

static create

static create(module: Type<any>, settings?: Partial<TsED.Configuration>): PlatformBuilder<Fastify.FastifyInstance<Fastify.RawServerDefault, Http.IncomingMessage, Http.ServerResponse<Http.IncomingMessage>, Fastify.FastifyBaseLogger, Fastify.FastifyTypeProviderDefault>>;

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<Fastify.FastifyInstance<Fastify.RawServerDefault, Http.IncomingMessage, Http.ServerResponse<Http.IncomingMessage>, Fastify.FastifyBaseLogger, Fastify.FastifyTypeProviderDefault>>>;

Bootstrap a server application

mapLayers

mapLayers(layers: PlatformLayer[]): Promise<void>;

mapHandler

mapHandler(handler: (...args: any[]) => any, metadata: PlatformHandlerMetadata): (...args: any[]) => any;

useContext

useContext(): Promise<void>;

createApp

createApp(): {
     app: Fastify.FastifyInstance<Fastify.RawServerDefault, Http.IncomingMessage, Http.ServerResponse<Http.IncomingMessage>, Fastify.FastifyBaseLogger, Fastify.FastifyTypeProviderDefault>;
     callback: () => (request: IncomingMessage, response: ServerResponse) => Promise<void>;
 };

afterLoadRoutes

afterLoadRoutes(): Promise<void>;

getServers

getServers(): any[];

bodyParser

bodyParser(type: string, opts: Record<string, any> | undefined): any;

statics

statics(endpoint: string, options: PlatformStaticsOptions & FastifyStaticOptions): Promise<void>;

protected compose

protected compose(layer: PlatformLayer, wildcard?: string): (req: FastifyRequest, _: FastifyReply) => Promise<Promise<any>>;

protected resolvePlugins

protected resolvePlugins(): Promise<PlatformFastifyPluginLoadingOptions[]>;