NestApplication | @nestjs/core

publicapi

Hierarchy

NestApplicationContext
- NestApplication

Implements

INestApplicationContext
INestApplication

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

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

Properties

Private Readonly appOptions

appOptions: NestApplicationOptions

Private Readonly config

config: ApplicationConfig

Protected Readonly container

container: NestContainer

Private Readonly httpAdapter

httpAdapter: HttpServer

Private httpServer

httpServer: any

Protected Readonly injector

injector: Injector = new Injector()

Protected isInitialized

isInitialized: boolean = false

Private isListening

isListening: boolean = false

Private Readonly logger

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

Private Readonly microservices

microservices: any[] = []

Private Readonly microservicesModule

microservicesModule: any = MicroservicesModule && new MicroservicesModule()

Private Readonly middlewareContainer

middlewareContainer: MiddlewareContainer = new MiddlewareContainer(this.container,)

Private Readonly middlewareModule

middlewareModule: MiddlewareModule = new MiddlewareModule()

Private Readonly routesResolver

routesResolver: Resolver

Private Readonly socketModule

socketModule: any = SocketModule && new SocketModule()

Methods

applyOptions

applyOptions(): void

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

Protected callBeforeShutdownHook

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

Inherited from NestApplicationContext.callBeforeShutdownHook
- Defined in packages/core/nest-application-context.ts:255
Calls the beforeApplicationShutdown function on the registered modules and children.

Parameters
- Optional signal: string
Returns Promise<void>

Protected callBootstrapHook

callBootstrapHook(): Promise<void>

Inherited from NestApplicationContext.callBootstrapHook
- Defined in packages/core/nest-application-context.ts:233
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 packages/core/nest-application-context.ts:222
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 packages/core/nest-application-context.ts:211
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 packages/core/nest-application-context.ts:244
Calls the onApplicationShutdown function on the registered modules and children.

Parameters
- Optional signal: string
Returns Promise<void>

close

close(): Promise<void>

Inherited from NestApplicationContext.close
- Defined in packages/core/nest-application-context.ts:115
Returns Promise<void>

connectMicroservice

connectMicroservice<T>(microserviceOptions: T, hybridAppOptions?: NestHybridApplicationOptions): INestMicroservice

- Defined in packages/core/nest-application.ts:176
Type parameters
- T: object
Parameters
- microserviceOptions: T
- Default value hybridAppOptions: NestHybridApplicationOptions = {}
Returns INestMicroservice

createServer

createServer<T>(): T

- Defined in packages/core/nest-application.ts:112
Type parameters
- T = any
Returns T

Protected dispose

dispose(): Promise<void>

Overrides NestApplicationContext.dispose
- Defined in packages/core/nest-application.ts:77
Returns Promise<void>

enableCors

enableCors(options?: CorsOptions): void

- Defined in packages/core/nest-application.ts:227
Parameters
- Optional options: CorsOptions
Returns void

enableShutdownHooks

enableShutdownHooks(signals?: (ShutdownSignal | string)[]): this

Inherited from NestApplicationContext.enableShutdownHooks
- Defined in packages/core/nest-application-context.ts:136
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: (ShutdownSignal | string)[] = []
Returns this

The Nest application context instance

Protected find

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

Inherited from NestApplicationContext.find
- Defined in packages/core/nest-application-context.ts:262
Type parameters
- TInput = any
- TResult = TInput
Parameters
- typeOrToken: Type<TInput> | Abstract<TInput> | string | symbol
- Optional contextModule: Module
Returns TResult

get

get<TInput, TResult>(typeOrToken: Type<TInput> | Abstract<TInput> | string | symbol, options?: { strict: boolean }): TResult

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

getHttpAdapter

getHttpAdapter(): AbstractHttpAdapter

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

getHttpServer

getHttpServer(): any

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

getMicroservices

getMicroservices(): INestMicroservice[]

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

Private getProtocol

getProtocol(): "http" | "https"

- Defined in packages/core/nest-application.ts:339
Returns "http" | "https"

getUnderlyingHttpServer

getUnderlyingHttpServer<T>(): T

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

getUrl

getUrl(): Promise<string>

- Defined in packages/core/nest-application.ts:253
Returns Promise<string>

Private host

host(): string | undefined

- Defined in packages/core/nest-application.ts:331
Returns string | undefined

init

init(): Promise<this>

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

listen

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

- Defined in packages/core/nest-application.ts:231
Parameters
- port: number | string
- Optional callback: () => void
  - - (): void
    - Returns void
Returns Promise<any>
- Defined in packages/core/nest-application.ts:235
Parameters
- port: number | string
- hostname: string
- Optional callback: () => void
  - - (): void
    - Returns void
Returns Promise<any>

listenAsync

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

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

Private listenToPromise

listenToPromise(microservice: INestMicroservice): Promise<unknown>

- Defined in packages/core/nest-application.ts:350
Parameters
- microservice: INestMicroservice
Returns Promise<unknown>

Protected listenToShutdownSignals

listenToShutdownSignals(signals: string[]): void

Inherited from NestApplicationContext.listenToShutdownSignals
- Defined in packages/core/nest-application-context.ts:169
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 packages/core/nest-application.ts:93
Returns void

Private registerMiddleware

registerMiddleware(instance: any): Promise<void>

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

registerModules

registerModules(): Promise<void>

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

registerParserMiddleware

registerParserMiddleware(): void

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

registerRequestByContextId

registerRequestByContextId<T>(request: T, contextId: ContextId): void

Inherited from NestApplicationContext.registerRequestByContextId
- Defined in packages/core/nest-application-context.ts:94
Type parameters
- T = any
Parameters
- request: T
- contextId: ContextId
Returns void

registerRouter

registerRouter(): Promise<void>

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

registerRouterHooks

registerRouterHooks(): Promise<void>

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

registerWsModule

registerWsModule(): void

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

resolve

resolve<TInput, TResult>(typeOrToken: Type<TInput> | Abstract<TInput> | string | symbol, contextId?: ContextId, options?: { strict: boolean }): Promise<TResult>

Inherited from NestApplicationContext.resolve
- Defined in packages/core/nest-application-context.ts:81
Type parameters
- TInput = any
- TResult = TInput
Parameters
- typeOrToken: Type<TInput> | Abstract<TInput> | string | symbol
- Default value contextId: ContextId = createContextId()
- Default value options: { strict: boolean } = { strict: false }
  - strict: boolean
Returns Promise<TResult>

Protected resolvePerContext

resolvePerContext<TInput, TResult>(typeOrToken: Type<TInput> | Abstract<TInput> | string | symbol, contextModule: Module, contextId: ContextId, options?: { strict: boolean }): Promise<TResult>

Inherited from NestApplicationContext.resolvePerContext
- Defined in packages/core/nest-application-context.ts:280
Type parameters
- TInput = any
- TResult = TInput
Parameters
- typeOrToken: Type<TInput> | Abstract<TInput> | string | symbol
- contextModule: Module
- contextId: ContextId
- Optional options: { strict: boolean }
  - strict: boolean
Returns Promise<TResult>

select

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

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

selectContextModule

selectContextModule(): void

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

setBaseViewsDir

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

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

setGlobalPrefix

setGlobalPrefix(prefix: string): this

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

setViewEngine

setViewEngine(engineOrOptions: any): this

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

startAllMicroservices

startAllMicroservices(callback?: () => void): this

- Defined in packages/core/nest-application.ts:211
Parameters
- Optional callback: () => void
  - - (): void
    - Returns void
Returns this

startAllMicroservicesAsync

startAllMicroservicesAsync(): Promise<void>

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

Protected unsubscribeFromProcessSignals

unsubscribeFromProcessSignals(): void

Inherited from NestApplicationContext.unsubscribeFromProcessSignals
- Defined in packages/core/nest-application-context.ts:198
Unsubscribes from shutdown signals (process events)

Returns void

use

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

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

useGlobalFilters

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

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

useGlobalGuards

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

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

useGlobalInterceptors

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

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

useGlobalPipes

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

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

useLogger

useLogger(logger: LoggerService | LogLevel[] | false): void

Inherited from NestApplicationContext.useLogger
- Defined in packages/core/nest-application-context.ts:123
Parameters
- logger: LoggerService | LogLevel[] | false
Returns void

useStaticAssets

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

- Defined in packages/core/nest-application.ts:313
Parameters
- options: any
Returns this
- Defined in packages/core/nest-application.ts:314
Parameters
- path: string
- Optional options: any
Returns this

useWebSocketAdapter

useWebSocketAdapter(adapter: WebSocketAdapter): this

- Defined in packages/core/nest-application.ts:288
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 Readonly appOptions

Private Readonly config

Protected Readonly container

Private Readonly httpAdapter

Private httpServer

Protected Readonly injector

Protected isInitialized

Private isListening

Private Readonly logger

Private Readonly microservices

Private Readonly microservicesModule

Private Readonly middlewareContainer

Private Readonly middlewareModule

Private Readonly routesResolver

Private Readonly socketModule

Methods

applyOptions

Returns void

Protected callBeforeShutdownHook

Parameters

Optional signal: string

Returns Promise<void>

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<void>

connectMicroservice

Type parameters

T: object

Parameters

microserviceOptions: T

Default value hybridAppOptions: NestHybridApplicationOptions = {}

Returns INestMicroservice

createServer

Type parameters

T = any

Returns T

Protected dispose

Returns Promise<void>

enableCors

Parameters

Optional options: CorsOptions

Returns void

enableShutdownHooks

Parameters

Default value signals: (ShutdownSignal | string)[] = []

Returns this

Protected find

Type parameters

TInput = any

TResult = TInput

Parameters

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

Optional contextModule: Module

Returns TResult

get

Type parameters