UNPKG

3.18 kBTypeScriptView Raw
1import { CanActivate, ExceptionFilter, HttpServer, INestApplication, INestMicroservice, NestHybridApplicationOptions, NestInterceptor, PipeTransform, VersioningOptions, WebSocketAdapter } from '@nestjs/common';
2import { CorsOptions, CorsOptionsDelegate } from '@nestjs/common/interfaces/external/cors-options.interface';
3import { GlobalPrefixOptions } from '@nestjs/common/interfaces/global-prefix-options.interface';
4import { NestApplicationOptions } from '@nestjs/common/interfaces/nest-application-options.interface';
5import { AbstractHttpAdapter } from './adapters';
6import { ApplicationConfig } from './application-config';
7import { NestContainer } from './injector/container';
8import { NestApplicationContext } from './nest-application-context';
9/**
10 * @publicApi
11 */
12export declare class NestApplication extends NestApplicationContext implements INestApplication {
13 private readonly httpAdapter;
14 private readonly config;
15 private readonly appOptions;
16 private readonly logger;
17 private readonly middlewareModule;
18 private readonly middlewareContainer;
19 private readonly microservicesModule;
20 private readonly socketModule;
21 private readonly routesResolver;
22 private readonly microservices;
23 private httpServer;
24 private isListening;
25 constructor(container: NestContainer, httpAdapter: HttpServer, config: ApplicationConfig, appOptions?: NestApplicationOptions);
26 protected dispose(): Promise<void>;
27 getHttpAdapter(): AbstractHttpAdapter;
28 registerHttpServer(): void;
29 getUnderlyingHttpServer<T>(): T;
30 applyOptions(): void;
31 createServer<T = any>(): T;
32 registerModules(): Promise<void>;
33 registerWsModule(): void;
34 init(): Promise<this>;
35 registerParserMiddleware(): void;
36 registerRouter(): Promise<void>;
37 registerRouterHooks(): Promise<void>;
38 connectMicroservice<T extends object>(microserviceOptions: T, hybridAppOptions?: NestHybridApplicationOptions): INestMicroservice;
39 getMicroservices(): INestMicroservice[];
40 getHttpServer(): any;
41 startAllMicroservices(): Promise<this>;
42 startAllMicroservicesAsync(): Promise<this>;
43 use(...args: [any, any?]): this;
44 enableCors(options?: CorsOptions | CorsOptionsDelegate<any>): void;
45 enableVersioning(options?: VersioningOptions): this;
46 listen(port: number | string): Promise<any>;
47 listen(port: number | string, hostname: string): Promise<any>;
48 listenAsync(port: number | string, ...args: any[]): Promise<any>;
49 getUrl(): Promise<string>;
50 private formatAddress;
51 setGlobalPrefix(prefix: string, options?: GlobalPrefixOptions): this;
52 useWebSocketAdapter(adapter: WebSocketAdapter): this;
53 useGlobalFilters(...filters: ExceptionFilter[]): this;
54 useGlobalPipes(...pipes: PipeTransform<any>[]): this;
55 useGlobalInterceptors(...interceptors: NestInterceptor[]): this;
56 useGlobalGuards(...guards: CanActivate[]): this;
57 useStaticAssets(options: any): this;
58 useStaticAssets(path: string, options?: any): this;
59 setBaseViewsDir(path: string | string[]): this;
60 setViewEngine(engineOrOptions: any): this;
61 private host;
62 private getProtocol;
63 private registerMiddleware;
64}