UNPKG

3.53 kBTypeScriptView Raw
1import { RequestMethod } from '../../enums';
2import { CorsOptions, CorsOptionsDelegate } from '../../interfaces/external/cors-options.interface';
3import { NestApplicationOptions } from '../../interfaces/nest-application-options.interface';
4import { VersioningOptions, VersionValue } from '../version-options.interface';
5export declare type ErrorHandler<TRequest = any, TResponse = any> = (error: any, req: TRequest, res: TResponse, next?: Function) => any;
6export declare type RequestHandler<TRequest = any, TResponse = any> = (req: TRequest, res: TResponse, next?: Function) => any;
7export interface HttpServer<TRequest = any, TResponse = any> {
8 use(handler: RequestHandler<TRequest, TResponse> | ErrorHandler<TRequest, TResponse>): any;
9 use(path: string, handler: RequestHandler<TRequest, TResponse> | ErrorHandler<TRequest, TResponse>): any;
10 get(handler: RequestHandler<TRequest, TResponse>): any;
11 get(path: string, handler: RequestHandler<TRequest, TResponse>): any;
12 post(handler: RequestHandler<TRequest, TResponse>): any;
13 post(path: string, handler: RequestHandler<TRequest, TResponse>): any;
14 head(handler: RequestHandler<TRequest, TResponse>): any;
15 head(path: string, handler: RequestHandler<TRequest, TResponse>): any;
16 delete(handler: RequestHandler<TRequest, TResponse>): any;
17 delete(path: string, handler: RequestHandler<TRequest, TResponse>): any;
18 put(handler: RequestHandler<TRequest, TResponse>): any;
19 put(path: string, handler: RequestHandler<TRequest, TResponse>): any;
20 patch(handler: RequestHandler<TRequest, TResponse>): any;
21 patch(path: string, handler: RequestHandler<TRequest, TResponse>): any;
22 all(path: string, handler: RequestHandler<TRequest, TResponse>): any;
23 all(handler: RequestHandler<TRequest, TResponse>): any;
24 options(handler: RequestHandler<TRequest, TResponse>): any;
25 options(path: string, handler: RequestHandler<TRequest, TResponse>): any;
26 listen(port: number | string, callback?: () => void): any;
27 listen(port: number | string, hostname: string, callback?: () => void): any;
28 reply(response: any, body: any, statusCode?: number): any;
29 status(response: any, statusCode: number): any;
30 end(response: any, message?: string): any;
31 render(response: any, view: string, options: any): any;
32 redirect(response: any, statusCode: number, url: string): any;
33 isHeadersSent(response: any): boolean;
34 setHeader(response: any, name: string, value: string): any;
35 setErrorHandler?(handler: Function, prefix?: string): any;
36 setNotFoundHandler?(handler: Function, prefix?: string): any;
37 useStaticAssets?(...args: any[]): this;
38 setBaseViewsDir?(path: string | string[]): this;
39 setViewEngine?(engineOrOptions: any): this;
40 createMiddlewareFactory(method: RequestMethod): ((path: string, callback: Function) => any) | Promise<(path: string, callback: Function) => any>;
41 getRequestHostname?(request: TRequest): string;
42 getRequestMethod?(request: TRequest): string;
43 getRequestUrl?(request: TRequest): string;
44 getInstance(): any;
45 registerParserMiddleware(...args: any[]): any;
46 enableCors(options: CorsOptions | CorsOptionsDelegate<TRequest>): any;
47 getHttpServer(): any;
48 initHttpServer(options: NestApplicationOptions): void;
49 close(): any;
50 getType(): string;
51 init?(): Promise<void>;
52 applyVersionFilter(handler: Function, version: VersionValue, versioningOptions: VersioningOptions): (req: TRequest, res: TResponse, next: () => void) => Function;
53}