Class NestApplicationContext

publicapi

Hierarchy

NestApplicationContext
- NestApplication

Implements

INestApplicationContext

Index

Constructors

constructor

Properties

Accessors

instanceLinksHost

Methods

Constructors

constructor

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

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

Properties

Private _instanceLinksHost

_instanceLinksHost: InstanceLinksHost

Private Readonly activeShutdownSignals

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

Protected Readonly container

container: NestContainer

Private contextModule

contextModule: Module

Protected Readonly injector

injector: Injector = new Injector()

Protected isInitialized

isInitialized: boolean = false

Private Readonly scope

scope: Type<any>[]

Private Optional shutdownCleanupRef

shutdownCleanupRef: (...args: unknown[]) => unknown

Type declaration

- (...args: unknown[]): unknown
- Parameters
  - Rest ...args: unknown[]
  Returns unknown

Accessors

Private instanceLinksHost

get instanceLinksHost(): InstanceLinksHost

- Defined in packages/core/nest-application-context.ts:40
Returns InstanceLinksHost

Methods

Protected callBeforeShutdownHook

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

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

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

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

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

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

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

Protected dispose

dispose(): Promise<void>

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

enableShutdownHooks

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

- 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

- 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

- 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

init

init(): Promise<this>

- Defined in packages/core/nest-application-context.ts:104
Initalizes the Nest application. Calls the Nest lifecycle events.

Returns Promise<this>

The NestApplicationContext instance as Promise

Protected listenToShutdownSignals

listenToShutdownSignals(signals: string[]): void

- 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

registerRequestByContextId

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

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

resolve

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

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

- 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

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

selectContextModule

selectContextModule(): void

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

Protected unsubscribeFromProcessSignals

unsubscribeFromProcessSignals(): void

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

Returns void

useLogger

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

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

Generated using TypeDoc