@nestjs/platform-express/adapters/express-adapter.d.ts

Nest - modern, fast, powerful node.js web framework (@platform-express)

import { type RequestMethod, type VersioningOptions } from '@nestjs/common';
import express from 'express';
import type { Server } from 'http';
import * as http from 'http';
import * as https from 'https';
import { NestExpressBodyParserOptionsFor, NestExpressBodyParserType } from '../interfaces/nest-express-body-parser.interface.js';
import { ServeStaticOptions } from '../interfaces/serve-static-options.interface.js';
import { type CorsOptions, type CorsOptionsDelegate, type VersionValue } from '@nestjs/common/internal';
import type { NestApplicationOptions } from '@nestjs/common';
import { AbstractHttpAdapter } from '@nestjs/core';
type VersionedRoute = <TRequest extends Record<string, any> = any, TResponse = any>(req: TRequest, res: TResponse, next: () => void) => any;
/**
 * @publicApi
 */
export declare class ExpressAdapter extends AbstractHttpAdapter<http.Server | https.Server> {
    private readonly routerMethodFactory;
    private readonly logger;
    private readonly openConnections;
    private readonly registeredPrefixes;
    private isShuttingDown;
    private onRequestHook?;
    private onResponseHook?;
    constructor(instance?: any);
    setOnRequestHook(onRequestHook: (req: express.Request, res: express.Response, done: () => void) => Promise<void> | void): void;
    setOnResponseHook(onResponseHook: (req: express.Request, res: express.Response) => Promise<void> | void): void;
    reply(response: any, body: any, statusCode?: number): any;
    status(response: any, statusCode: number): any;
    end(response: any, message?: string): any;
    render(response: any, view: string, options: any): any;
    redirect(response: any, statusCode: number, url: string): any;
    setErrorHandler(handler: Function, prefix?: string): any;
    setNotFoundHandler(handler: Function, prefix?: string): any;
    isHeadersSent(response: any): boolean;
    getHeader(response: any, name: string): any;
    setHeader(response: any, name: string, value: string): any;
    appendHeader(response: any, name: string, value: string): any;
    normalizePath(path: string): string;
    listen(port: string | number, callback?: () => void): Server;
    listen(port: string | number, hostname: string, callback?: () => void): Server;
    beforeClose(): void;
    close(): Promise<unknown> | undefined;
    set(...args: any[]): any;
    enable(...args: any[]): any;
    disable(...args: any[]): any;
    engine(...args: any[]): any;
    useStaticAssets(path: string, options: ServeStaticOptions): any;
    setBaseViewsDir(path: string | string[]): any;
    setViewEngine(engine: string): any;
    getRequestHostname(request: any): string;
    getRequestMethod(request: any): string;
    getRequestUrl(request: any): string;
    enableCors(options: CorsOptions | CorsOptionsDelegate<any>): any;
    createMiddlewareFactory(requestMethod: RequestMethod): (path: string, callback: Function) => any;
    initHttpServer(options: NestApplicationOptions): void;
    registerParserMiddleware(prefix?: string, rawBody?: boolean): void;
    useBodyParser<ParserType extends NestExpressBodyParserType>(type: ParserType, rawBody: boolean, options?: NestExpressBodyParserOptionsFor<ParserType>): this;
    setLocal(key: string, value: any): this;
    getType(): string;
    isRouteOrderSensitive(): boolean;
    applyVersionFilter(handler: Function, version: VersionValue, versioningOptions: VersioningOptions): VersionedRoute;
    mapException(error: unknown): unknown;
    private trackOpenConnections;
    private closeOpenConnections;
    private isMiddlewareApplied;
    private setHeaderIfNotExists;
    private applyStreamHeaders;
}
export {};