Api Reference
Versions
v10.xv9.x
API > @nestjs/core

NestContainer

  
class NestContainer {
  constructor(_applicationConfig: ApplicationConfig = undefined, _contextOptions: any = undefined)
  serializedGraph: SerializedGraph
  applicationConfig: ApplicationConfig | undefined
  setHttpAdapter(httpAdapter: any)
  getHttpAdapterRef()
  getHttpAdapterHostRef()
  addModule(metatype: any, scope: ModuleScope): Promise<{...}
  replaceModule(metatypeToReplace: any, newMetatype: any, scope: ModuleScope): Promise<{...}
  addDynamicMetadata(token: string, dynamicModuleMetadata: DynamicModule, scope: Type<any>[])
  addDynamicModules(modules: any[], scope: Type<any>[])
  isGlobalModule(metatype: Type<any>, dynamicMetadata?: DynamicModule): boolean
  addGlobalModule(module: Module)
  getModules(): ModulesContainer
  getModuleCompiler(): ModuleCompiler
  getModuleByKey(moduleKey: string): Module | undefined
  getInternalCoreModuleRef(): Module | undefined
  addImport(relatedModule: any, token: string)
  addProvider(provider: Provider, token: string, enhancerSubtype?: EnhancerSubtype): string | symbol | Function
  addInjectable(injectable: Provider, token: string, enhancerSubtype: EnhancerSubtype, host?: Type<Injectable>)
  addExportedProviderOrModule(toExport: any, token: string)
  addController(controller: Type<any>, token: string)
  clear()
  replace(toReplace: any, options: { scope: any[]; })
  bindGlobalScope()
  bindGlobalsToImports(moduleRef: Module)
  bindGlobalModuleToModule(target: Module, globalModule: Module)
  getDynamicMetadataByToken(token: string, metadataKey?: string | number | symbol)
  registerCoreModuleRef(moduleRef: Module)
  getModuleTokenFactory(): ModuleOpaqueKeyFactory
  registerRequestProvider<T = any>(request: T, contextId: ContextId)
}

Constructor


constructor(_applicationConfig: ApplicationConfig = undefined, _contextOptions: any = undefined)

Parameters

Option Type Description
_applicationConfig ApplicationConfig

Optional. Default is undefined.
_contextOptions any

Optional. Default is undefined.

Properties

Property Description
serializedGraph: SerializedGraph Read-only.
applicationConfig: ApplicationConfig | undefined Read-only.

Methods

setHttpAdapter() 


setHttpAdapter(httpAdapter: any)

Parameters

Option Type Description
httpAdapter any

getHttpAdapterRef() 


getHttpAdapterRef()

Parameters

There are no parameters.

getHttpAdapterHostRef() 


getHttpAdapterHostRef()

Parameters

There are no parameters.

addModule() 


addModule(metatype: any, scope: ModuleScope): Promise<{
    moduleRef: Module;
    inserted: boolean;
} | undefined>

Parameters

Option Type Description
metatype any
scope ModuleScope

Returns

Promise<{ moduleRef: Module; inserted: boolean; } | undefined>

replaceModule() 


replaceModule(metatypeToReplace: any, newMetatype: any, scope: ModuleScope): Promise<{
    moduleRef: Module;
    inserted: boolean;
} | undefined>

Parameters

Option Type Description
metatypeToReplace any
newMetatype any
scope ModuleScope

Returns

Promise<{ moduleRef: Module; inserted: boolean; } | undefined>

addDynamicMetadata() 


addDynamicMetadata(token: string, dynamicModuleMetadata: DynamicModule, scope: Type<any>[])

Parameters

Option Type Description
token string
dynamicModuleMetadata DynamicModule
scope Type[]

addDynamicModules() 


addDynamicModules(modules: any[], scope: Type<any>[])

Parameters

Option Type Description
modules any[]
scope Type[]

isGlobalModule() 


isGlobalModule(metatype: Type<any>, dynamicMetadata?: DynamicModule): boolean

Parameters

Option Type Description
metatype Type
dynamicMetadata DynamicModule

Optional. Default is undefined.

Returns

boolean

addGlobalModule() 


addGlobalModule(module: Module)

Parameters

Option Type Description
module Module

getModules() 


getModules(): ModulesContainer

Parameters

There are no parameters.

Returns

ModulesContainer

getModuleCompiler() 


getModuleCompiler(): ModuleCompiler

Parameters

There are no parameters.

Returns

ModuleCompiler

getModuleByKey() 


getModuleByKey(moduleKey: string): Module | undefined

Parameters

Option Type Description
moduleKey string

Returns

Module | undefined

getInternalCoreModuleRef() 


getInternalCoreModuleRef(): Module | undefined

Parameters

There are no parameters.

Returns

Module | undefined

addImport() 


addImport(relatedModule: any, token: string)

Parameters

Option Type Description
relatedModule any
token string

addProvider() 


addProvider(provider: Provider, token: string, enhancerSubtype?: EnhancerSubtype): string | symbol | Function

Parameters

Option Type Description
provider Provider
token string
enhancerSubtype EnhancerSubtype

Optional. Default is undefined.

Returns

string | symbol | Function

addInjectable() 


addInjectable(injectable: Provider, token: string, enhancerSubtype: EnhancerSubtype, host?: Type<Injectable>)

Parameters

Option Type Description
injectable Provider
token string
enhancerSubtype EnhancerSubtype
host Type

Optional. Default is undefined.

addExportedProviderOrModule() 


addExportedProviderOrModule(toExport: any, token: string)

Parameters

Option Type Description
toExport any
token string

addController() 


addController(controller: Type<any>, token: string)

Parameters

Option Type Description
controller Type
token string

clear() 


clear()

Parameters

There are no parameters.

replace() 


replace(toReplace: any, options: { scope: any[]; })

Parameters

Option Type Description
toReplace any
options { scope: any[]; }

bindGlobalScope() 


bindGlobalScope()

Parameters

There are no parameters.

bindGlobalsToImports() 


bindGlobalsToImports(moduleRef: Module)

Parameters

Option Type Description
moduleRef Module

bindGlobalModuleToModule() 


bindGlobalModuleToModule(target: Module, globalModule: Module)

Parameters

Option Type Description
target Module
globalModule Module

getDynamicMetadataByToken() 


getDynamicMetadataByToken(token: string): Partial<DynamicModule>

Parameters

Option Type Description
token string

Returns

Partial<DynamicModule>

 

getDynamicMetadataByToken<K extends Exclude<keyof DynamicModule, 'global' | 'module'>>(token: string, metadataKey: K): DynamicModule[K]

Parameters

Option Type Description
token string
metadataKey K

Returns

DynamicModule[K]

registerCoreModuleRef() 


registerCoreModuleRef(moduleRef: Module)

Parameters

Option Type Description
moduleRef Module

getModuleTokenFactory() 


getModuleTokenFactory(): ModuleOpaqueKeyFactory

Parameters

There are no parameters.

Returns

ModuleOpaqueKeyFactory

registerRequestProvider() 


registerRequestProvider<T = any>(request: T, contextId: ContextId)

Parameters

Option Type Description
request T
contextId ContextId

© 2025 Developed by Antonio Tripodi & Livio Brunner | Deployed on: 2025-01-25T20:26:53.091Z