Class NestApplicationContext

Hierarchy

NestApplicationContext
- NestApplication

Implements

any

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new NestApplicationContext(container: NestContainer, scope?: Type<any>[], contextModule?: Module): NestApplicationContext

- Defined in core/nest-application-context.ts:25
Parameters
- container: NestContainer
- Default value scope: Type<any>[] = []
- Default value contextModule: Module = null
Returns NestApplicationContext

Properties

Private activeShutdownSignals

activeShutdownSignals: string[] = new Array<string>()

Protected container

container: NestContainer

Private containerScanner

containerScanner: ContainerScanner

Private contextModule

contextModule: Module

Private moduleTokenFactory

moduleTokenFactory: ModuleTokenFactory = new ModuleTokenFactory()

Private scope

scope: Type<any>[]

Methods

Protected callBootstrapHook

callBootstrapHook(): Promise<void>

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

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

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

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

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

enableShutdownHooks

enableShutdownHooks(signals?: any[]): this

- 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

- 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

- 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

- 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

init

init(): Promise<this>

- Defined in core/nest-application-context.ts:66
Returns Promise<this>

Protected listenToShutdownSignals

listenToShutdownSignals(signals: string[]): void

- 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

select

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

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

selectContextModule

selectContextModule(): void

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

useLogger

useLogger(logger: LoggerService): void

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

Generated using TypeDoc