class NestApplication extends NestApplicationContext implements INestApplication {
constructor(container: NestContainer, httpAdapter: HttpServer, config: ApplicationConfig, graphInspector: GraphInspector, appOptions: NestApplicationOptions = {})
protected logger: Logger
protected dispose(): Promise<void>
getHttpAdapter(): AbstractHttpAdapter
registerHttpServer()
getUnderlyingHttpServer<T>(): T
applyOptions()
createServer<T = any>(): T
registerModules()
registerWsModule()
init(): Promise<this>
registerParserMiddleware()
registerRouter()
registerRouterHooks()
connectMicroservice<T extends object>(microserviceOptions: T, hybridAppOptions: NestHybridApplicationOptions = {}): INestMicroservice
getMicroservices(): INestMicroservice[]
getHttpServer()
startAllMicroservices(): Promise<this>
use(...args: [any, any?]): this
useBodyParser(...args: [any, any?]): this
enableCors(options?: any): void
enableVersioning(options: VersioningOptions = { type: VersioningType.URI }): this
listen(port: string | number, ...args: any[]): Promise<any>
getUrl(): Promise<string>
setGlobalPrefix(prefix: string, options?: GlobalPrefixOptions): this
useWebSocketAdapter(adapter: WebSocketAdapter): this
useGlobalFilters(...filters: ExceptionFilter[]): this
useGlobalPipes(...pipes: PipeTransform<any>[]): this
useGlobalInterceptors(...interceptors: NestInterceptor[]): this
useGlobalGuards(...guards: CanActivate[]): this
useStaticAssets(pathOrOptions: any, options?: any): this
setBaseViewsDir(path: string | string[]): this
setViewEngine(engineOrOptions: any): this
constructor(container: NestContainer, appOptions: TOptions = {} as TOptions, contextModule: Module = null, scope: Type<any>[] = new Array<Type<any>>())
protected isInitialized: false
protected injector: Injector
protected logger: Logger
protected instanceLinksHost
protected container: NestContainer
protected appOptions: TOptions
selectContextModule()
select<T>(moduleType: any, selectOptions?: SelectOptions): INestApplicationContext
get<TInput = any, TResult = TInput>(typeOrToken: any, options: GetOrResolveOptions = { strict: false }): TResult | Array<TResult>
resolve<TInput = any, TResult = TInput>(typeOrToken: any, contextId: ContextId = createContextId(), options: GetOrResolveOptions = { strict: false }): Promise<TResult | Array<TResult>>
registerRequestByContextId<T = any>(request: T, contextId: ContextId)
init(): Promise<this>
close(signal?: string): Promise<void>
useLogger(logger: any)
flushLogs()
flushLogsOnOverride()
enableShutdownHooks(signals: any[] = []): this
protected dispose(): Promise<void>
protected listenToShutdownSignals(signals: string[])
protected unsubscribeFromProcessSignals()
protected callInitHook(): Promise<void>
protected callDestroyHook(): Promise<void>
protected callBootstrapHook(): Promise<void>
protected callShutdownHook(signal?: string): Promise<void>
protected callBeforeShutdownHook(signal?: string): Promise<void>
protected assertNotInPreviewMode(methodName: string)
}
Constructor
constructor(container: NestContainer, httpAdapter: HttpServer, config: ApplicationConfig, graphInspector: GraphInspector, appOptions: NestApplicationOptions = {})
Parameters
|
Properties
Property |
Description |
protected logger: Logger
|
Read-only.
|
Methods
dispose()
|
protected dispose(): Promise<void>
Parameters
There are no parameters.
Returns
Promise<void>
|
getHttpAdapter()
|
getHttpAdapter(): AbstractHttpAdapter
Parameters
There are no parameters.
Returns
AbstractHttpAdapter
|
registerHttpServer()
|
registerHttpServer()
Parameters
There are no parameters.
|
getUnderlyingHttpServer()
|
getUnderlyingHttpServer<T>(): T
Parameters
There are no parameters.
Returns
T
|
applyOptions()
|
applyOptions()
Parameters
There are no parameters.
|
createServer()
|
createServer<T = any>(): T
Parameters
There are no parameters.
Returns
T
|
registerModules()
|
registerModules()
Parameters
There are no parameters.
|
registerWsModule()
|
registerWsModule()
Parameters
There are no parameters.
|
init()
|
init(): Promise<this>
Parameters
There are no parameters.
Returns
Promise<this>
|
registerParserMiddleware()
|
registerParserMiddleware()
Parameters
There are no parameters.
|
registerRouter()
|
registerRouter()
Parameters
There are no parameters.
|
registerRouterHooks()
|
registerRouterHooks()
Parameters
There are no parameters.
|
connectMicroservice()
|
connectMicroservice<T extends object>(microserviceOptions: T, hybridAppOptions: NestHybridApplicationOptions = {}): INestMicroservice
Parameters
Returns
INestMicroservice
|
getMicroservices()
|
getMicroservices(): INestMicroservice[]
Parameters
There are no parameters.
Returns
INestMicroservice[]
|
getHttpServer()
|
getHttpServer()
Parameters
There are no parameters.
|
startAllMicroservices()
|
startAllMicroservices(): Promise<this>
Parameters
There are no parameters.
Returns
Promise<this>
|
use()
|
use(...args: [any, any?]): this
Parameters
Option |
Type |
Description |
args
|
[any, any?] |
|
Returns
this
|
useBodyParser()
|
useBodyParser(...args: [any, any?]): this
Parameters
Option |
Type |
Description |
args
|
[any, any?] |
|
Returns
this
|
enableCors()
|
enableCors(options?: any): void
Parameters
Option |
Type |
Description |
options
|
any |
Optional. Default is undefined .
|
Returns
void
|
enableVersioning()
|
enableVersioning(options: VersioningOptions = { type: VersioningType.URI }): this
Parameters
Option |
Type |
Description |
options
|
VersioningOptions |
Optional. Default is { type: VersioningType.URI } .
|
Returns
this
|
listen()
|
listen(port: string | number): Promise<any>
Parameters
Option |
Type |
Description |
port
|
string | number |
|
Returns
Promise<any>
|
listen(port: string | number, hostname: string): Promise<any>
Parameters
Option |
Type |
Description |
port
|
string | number |
|
hostname
|
string |
|
Returns
Promise<any>
|
getUrl()
|
getUrl(): Promise<string>
Parameters
There are no parameters.
Returns
Promise<string>
|
setGlobalPrefix()
|
setGlobalPrefix(prefix: string, options?: GlobalPrefixOptions): this
Parameters
Option |
Type |
Description |
prefix
|
string |
|
options
|
GlobalPrefixOptions |
Optional. Default is undefined .
|
Returns
this
|
useWebSocketAdapter()
|
useWebSocketAdapter(adapter: WebSocketAdapter): this
Parameters
Returns
this
|
useGlobalFilters()
|
useGlobalFilters(...filters: ExceptionFilter[]): this
Parameters
Returns
this
|
useGlobalPipes()
|
useGlobalPipes(...pipes: PipeTransform<any>[]): this
Parameters
Returns
this
|
useGlobalInterceptors()
|
useGlobalInterceptors(...interceptors: NestInterceptor[]): this
Parameters
Returns
this
|
useGlobalGuards()
|
useGlobalGuards(...guards: CanActivate[]): this
Parameters
Returns
this
|
useStaticAssets()
|
useStaticAssets(options: any): this
Parameters
Option |
Type |
Description |
options
|
any |
|
Returns
this
|
useStaticAssets(path: string, options?: any): this
Parameters
Option |
Type |
Description |
path
|
string |
|
options
|
any |
Optional. Default is undefined .
|
Returns
this
|
setBaseViewsDir()
|
setBaseViewsDir(path: string | string[]): this
Parameters
Option |
Type |
Description |
path
|
string | string[] |
|
Returns
this
|
setViewEngine()
|
setViewEngine(engineOrOptions: any): this
Parameters
Option |
Type |
Description |
engineOrOptions
|
any |
|
Returns
this
|