Class ModuleRegistry

ModuleRegistry - manages module lifecycle

Example

const registry = new ModuleRegistry(container, logger)
registry.register(AppModule)  // Traverses imports recursively
await registry.initialize()
// ... application running ...
await registry.shutdown()

Index

Constructors

constructor

Methods

getAllConsumers getAllControllers getAllJobs getAllMiddlewareConfigs initialize register registerAll shutdown

Constructors

constructor

new ModuleRegistry(container: Container, logger: LoggerService): ModuleRegistry
Parameters
- container: Container
- logger: LoggerService
Returns ModuleRegistry
- Defined in packages/core/src/module/module-registry.ts:61

Methods

getAllConsumers

getAllConsumers(): Constructor[]
Get all consumers registered from all modules

Returns Constructor[]
- Defined in packages/core/src/module/module-registry.ts:183

getAllControllers

getAllControllers(): Constructor[]
Get all controllers registered from all modules

Returns Constructor[]
- Defined in packages/core/src/module/module-registry.ts:176

getAllJobs

getAllJobs(): Constructor[]
Get all jobs registered from all modules

Returns Constructor[]
- Defined in packages/core/src/module/module-registry.ts:190

getAllMiddlewareConfigs

getAllMiddlewareConfigs(): MiddlewareConfigEntry[]
Get all middleware configurations from all modules

Returns MiddlewareConfigEntry[]
- Defined in packages/core/src/module/module-registry.ts:197

initialize

initialize(): Promise<void>
Initialize all modules (call configure and onInitialize hooks)

Returns Promise<void>
- Defined in packages/core/src/module/module-registry.ts:137

register

register(moduleOrDynamic: DynamicModule | ModuleClass<object>): void
Register a module (static or dynamic)
Parameters
- moduleOrDynamic: DynamicModule | ModuleClass<object>
  Module class decorated with @Module or DynamicModule from configure()
Returns void
- Defined in packages/core/src/module/module-registry.ts:71

registerAll

registerAll(modules: (DynamicModule | ModuleClass<object>)[]): void
Register multiple modules in order
Parameters
- modules: (DynamicModule | ModuleClass<object>)[]
Returns void
- Defined in packages/core/src/module/module-registry.ts:128

shutdown

shutdown(): Promise<void>
Shutdown all modules (call onShutdown hooks in reverse order)

Returns Promise<void>
- Defined in packages/core/src/module/module-registry.ts:204

Class ModuleRegistry

Example

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ModuleRegistry

Methods

getAllConsumers

Returns Constructor[]

getAllControllers

Returns Constructor[]

getAllJobs

Returns Constructor[]

getAllMiddlewareConfigs

Returns MiddlewareConfigEntry[]

initialize

Returns Promise<void>

register

Parameters

Returns void

registerAll

Parameters

Returns void

shutdown

Returns Promise<void>

Settings

On This Page