NestContainer

  
class NestContainer {
  constructor(_applicationConfig: ApplicationConfig = undefined)
  serializedGraph: SerializedGraph
  applicationConfig: ApplicationConfig | undefined
  setHttpAdapter(httpAdapter: any)
  getHttpAdapterRef()
  getHttpAdapterHostRef()
  addModule(metatype: any, scope: Type<any>[]): Promise<Module | undefined>
  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
  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>)
  addExportedProvider(provider: Type<any>, token: string)
  addController(controller: Type<any>, token: string)
  clear()
  replace(toReplace: any, options: any)
  bindGlobalScope()
  bindGlobalsToImports(moduleRef: Module)
  bindGlobalModuleToModule(target: Module, globalModule: Module)
  getDynamicMetadataByToken(token: string, metadataKey?: string | number | symbol)
  registerCoreModuleRef(moduleRef: Module)
  getModuleTokenFactory(): ModuleTokenFactory
  registerRequestProvider<T = any>(request: T, contextId: ContextId)
}

Constructor


constructor(_applicationConfig: ApplicationConfig = undefined)

Parameters

Option Type Description
_applicationConfig ApplicationConfig

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: Type<any>[]): Promise<Module | undefined>

Parameters

Option Type Description
metatype any
scope Type[]

Returns

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

Parameters

Option Type Description
moduleKey string

Returns

Module

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.

addExportedProvider()


addExportedProvider(provider: Type<any>, token: string)

Parameters

Option Type Description
provider Type
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: any)

Parameters

Option Type Description
toReplace any
options 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(): ModuleTokenFactory

Parameters

There are no parameters.

Returns

ModuleTokenFactory

registerRequestProvider()


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

Parameters

Option Type Description
request T
contextId ContextId