NestApplication | @nestjs/common

Hierarchy

NestApplicationContext
- NestApplication

Implements

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new NestApplication(container: NestContainer, httpAdapter: HttpServer, config: ApplicationConfig, appOptions?: NestApplicationOptions): NestApplication

Overrides NestApplicationContext.constructor
- Defined in core/nest-application.ts:48
Parameters
- container: NestContainer
- httpAdapter: HttpServer
- config: ApplicationConfig
- Default value appOptions: NestApplicationOptions = {}
Returns NestApplication

Properties

Private httpAdapter

httpAdapter: HttpServer

Private httpServer

httpServer: any

Private injector

injector: Injector = new Injector()

Private isInitialized

isInitialized: boolean = false

Private logger

logger: any = new Logger(NestApplication.name, true)

Private microservices

microservices: any[] = []

Private microservicesModule

microservicesModule: any = MicroservicesModule? new MicroservicesModule(): null

Private middlewareContainer

middlewareContainer: MiddlewareContainer = new MiddlewareContainer()

Private middlewareModule

middlewareModule: MiddlewareModule = new MiddlewareModule()

Private routesResolver

routesResolver: Resolver

Private socketModule

socketModule: any = SocketModule ? new SocketModule() : null

Methods

applyOptions

applyOptions(): this

- Defined in core/nest-application.ts:81
Returns this

Protected callBootstrapHook

callBootstrapHook(): Promise<void>

Inherited from NestApplicationContext.callBootstrapHook
- Defined in core/nest-application-context.ts:162
Calls the onApplicationBootstrap function on the registered modules and its children.

Returns Promise<void>

Protected callDestroyHook

callDestroyHook(): Promise<void>

Inherited from NestApplicationContext.callDestroyHook
- Defined in core/nest-application-context.ts:151
Calls the onModuleDestroy function on the registered modules and its children.

Returns Promise<void>

Protected callInitHook

callInitHook(): Promise<void>

Inherited from NestApplicationContext.callInitHook
- Defined in core/nest-application-context.ts:140
Calls the onModuleInit function on the registered modules and its children.

Returns Promise<void>

Protected callShutdownHook

callShutdownHook(signal?: string): Promise<void>

Inherited from NestApplicationContext.callShutdownHook
- Defined in core/nest-application-context.ts:173
Calls the onApplicationShutdown function on the registered modules and children.

Parameters
- Optional signal: string
Returns Promise<void>

close

close(): Promise<any>

Overrides NestApplicationContext.close
- Defined in core/nest-application.ts:224
Returns Promise<any>

connectMicroservice

connectMicroservice(options: MicroserviceOptions): INestMicroservice

- Defined in core/nest-application.ts:152
Parameters
- options: MicroserviceOptions
Returns INestMicroservice

createServer

createServer<T>(): T

- Defined in core/nest-application.ts:92
Type parameters
- T
Returns T

enableCors

enableCors(options?: CorsOptions): this

- Defined in core/nest-application.ts:197
Parameters
- Optional options: CorsOptions
Returns this

enableShutdownHooks

enableShutdownHooks(signals?: any[]): this

Inherited from NestApplicationContext.enableShutdownHooks
- Defined in core/nest-application-context.ts:90
Enables the usage of shutdown hooks. Will call the onApplicationShutdown function of a provider if the process receives a shutdown signal.

Parameters
- Default value signals: any[] = []
Returns this

The Nest application context instance

Protected find

find<TInput, TResult>(typeOrToken: Type<TInput> | Abstract<TInput> | string | symbol): TResult

Inherited from NestApplicationContext.find
- Defined in core/nest-application-context.ts:180
Type parameters
- TInput
- TResult
Parameters
- typeOrToken: Type<TInput> | Abstract<TInput> | string | symbol
Returns TResult

Protected findInstanceByPrototypeOrToken

findInstanceByPrototypeOrToken<TInput, TResult>(metatypeOrToken: Type<TInput> | Abstract<TInput> | string | symbol, contextModule: Partial<Module>): TResult

Inherited from NestApplicationContext.findInstanceByPrototypeOrToken
- Defined in core/nest-application-context.ts:186
Type parameters
- TInput
- TResult
Parameters
- metatypeOrToken: Type<TInput> | Abstract<TInput> | string | symbol
- contextModule: Partial<Module>
Returns TResult

get

get<TInput, TResult>(typeOrToken: Type<TInput> | Abstract<TInput> | string | symbol, options?: object): TResult

Inherited from NestApplicationContext.get
- Defined in core/nest-application-context.ts:53
Type parameters
- TInput
- TResult
Parameters
- typeOrToken: Type<TInput> | Abstract<TInput> | string | symbol
- Default value options: object = { strict: false }
  - strict: boolean
Returns TResult

getHttpAdapter

getHttpAdapter(): AbstractHttpAdapter

- Defined in core/nest-application.ts:69
Returns AbstractHttpAdapter

getHttpServer

getHttpServer(): any

- Defined in core/nest-application.ts:177
Returns any

getMicroservices

getMicroservices(): INestMicroservice[]

- Defined in core/nest-application.ts:173
Returns INestMicroservice[]

getUnderlyingHttpServer

getUnderlyingHttpServer<T>(): T

- Defined in core/nest-application.ts:77
Type parameters
- T
Returns T

init

init(): Promise<this>

Overrides NestApplicationContext.init
- Defined in core/nest-application.ts:119
Returns Promise<this>

listen

listen(port: number | string, callback?: function): Promise<any>
listen(port: number | string, hostname: string, callback?: function): Promise<any>

- Defined in core/nest-application.ts:202
Parameters
- port: number | string
- Optional callback: function
  - - (): void
    - Returns void
Returns Promise<any>
- Defined in core/nest-application.ts:206
Parameters
- port: number | string
- hostname: string
- Optional callback: function
  - - (): void
    - Returns void
Returns Promise<any>

listenAsync

listenAsync(port: number | string, hostname?: string): Promise<any>

- Defined in core/nest-application.ts:218
Parameters
- port: number | string
- Optional hostname: string
Returns Promise<any>

Private listenToPromise

listenToPromise(microservice: INestMicroservice): any

- Defined in core/nest-application.ts:293
Parameters
- microservice: INestMicroservice
Returns any

Protected listenToShutdownSignals

listenToShutdownSignals(signals: string[]): void

Inherited from NestApplicationContext.listenToShutdownSignals
- Defined in core/nest-application-context.ts:121
Listens to shutdown signals by listening to process events

Parameters
- signals: string[]
  
  The system signals it should listen to
Returns void

registerHttpServer

registerHttpServer(): void

- Defined in core/nest-application.ts:73
Returns void

Private registerMiddleware

registerMiddleware(instance: any): Promise<void>

- Defined in core/nest-application.ts:286
Parameters
- instance: any
Returns Promise<void>

registerModules

registerModules(): Promise<void>

- Defined in core/nest-application.ts:97
Returns Promise<void>

registerParserMiddleware

registerParserMiddleware(): void

- Defined in core/nest-application.ts:135
Returns void

registerRouter

registerRouter(): Promise<void>

- Defined in core/nest-application.ts:139
Returns Promise<void>

registerRouterHooks

registerRouterHooks(): Promise<void>

- Defined in core/nest-application.ts:147
Returns Promise<void>

registerWsModule

registerWsModule(): void

- Defined in core/nest-application.ts:112
Returns void

select

select<T>(module: Type<T>): INestApplicationContext

Inherited from NestApplicationContext.select
- Defined in core/nest-application-context.ts:40
Type parameters
- T
Parameters
- module: Type<T>
Returns INestApplicationContext

selectContextModule

selectContextModule(): void

Inherited from NestApplicationContext.selectContextModule
- Defined in core/nest-application-context.ts:35
Returns void

setBaseViewsDir

setBaseViewsDir(path: string | string[]): this

- Defined in core/nest-application.ts:275
Parameters
- path: string | string[]
Returns this

setGlobalPrefix

setGlobalPrefix(prefix: string): this

- Defined in core/nest-application.ts:237
Parameters
- prefix: string
Returns this

setViewEngine

setViewEngine(engineOrOptions: any): this

- Defined in core/nest-application.ts:280
Parameters
- engineOrOptions: any
Returns this

startAllMicroservices

startAllMicroservices(callback?: function): this

- Defined in core/nest-application.ts:181
Parameters
- Optional callback: function
  - - (): void
    - Returns void
Returns this

startAllMicroservicesAsync

startAllMicroservicesAsync(): Promise<void>

- Defined in core/nest-application.ts:188
Returns Promise<void>

use

use(...args: [any, any]): this

- Defined in core/nest-application.ts:192
Parameters
- Rest ...args: [any, any]
Returns this

useGlobalFilters

useGlobalFilters(...filters: ExceptionFilter[]): this

- Defined in core/nest-application.ts:247
Parameters
- Rest ...filters: ExceptionFilter[]
Returns this

useGlobalGuards

useGlobalGuards(...guards: CanActivate[]): this

- Defined in core/nest-application.ts:262
Parameters
- Rest ...guards: CanActivate[]
Returns this

useGlobalInterceptors

useGlobalInterceptors(...interceptors: NestInterceptor[]): this

- Defined in core/nest-application.ts:257
Parameters
- Rest ...interceptors: NestInterceptor[]
Returns this

useGlobalPipes

useGlobalPipes(...pipes: PipeTransform<any>[]): this

- Defined in core/nest-application.ts:252
Parameters
- Rest ...pipes: PipeTransform<any>[]
Returns this

useLogger

useLogger(logger: LoggerService): void

Inherited from NestApplicationContext.useLogger
- Defined in core/nest-application-context.ts:77
Parameters
- logger: LoggerService
Returns void

useStaticAssets

useStaticAssets(options: any): this
useStaticAssets(path: string, options?: any): this

- Defined in core/nest-application.ts:267
Parameters
- options: any
Returns this
- Defined in core/nest-application.ts:268
Parameters
- path: string
- Optional options: any
Returns this

useWebSocketAdapter

useWebSocketAdapter(adapter: WebSocketAdapter): this

- Defined in core/nest-application.ts:242
Parameters
- adapter: WebSocketAdapter
Returns this

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

container: NestContainer

httpAdapter: HttpServer

config: ApplicationConfig

Default value appOptions: NestApplicationOptions = {}

Returns NestApplication

Properties

Private appOptions

Private config

Protected container

Private httpAdapter

Private httpServer

Private injector

Private isInitialized

Private logger

Private microservices

Private microservicesModule

Private middlewareContainer

Private middlewareModule

Private routesResolver

Private socketModule

Methods

applyOptions

Returns this

Protected callBootstrapHook

Returns Promise<void>

Protected callDestroyHook

Returns Promise<void>

Protected callInitHook

Returns Promise<void>

Protected callShutdownHook

Parameters

Optional signal: string

Returns Promise<void>

close

Returns Promise<any>

connectMicroservice

Parameters

options: MicroserviceOptions

Returns INestMicroservice

createServer

Type parameters

T

Returns T

enableCors

Parameters

Optional options: CorsOptions

Returns this

enableShutdownHooks

Parameters

Default value signals: any[] = []

Returns this

Protected find

Type parameters

TInput

TResult

Parameters

typeOrToken: Type<TInput> | Abstract<TInput> | string | symbol

Returns TResult

Protected findInstanceByPrototypeOrToken

Type parameters

TInput

TResult

Parameters

metatypeOrToken: Type<TInput> | Abstract<TInput> | string | symbol

contextModule: Partial<Module>

Returns TResult

get

Type parameters

TInput

TResult

Parameters