What must the object returned by a dynamic module's static method always include in NestJS?

Q: What must the object returned by a dynamic module's static method always include in NestJS?

static forRoot(options: Options): DynamicModule { return { module: DatabaseModule, // REQUIRED — must reference the class itself global: true, // optional — makes this instance global imports: [], // optional providers: [ { provide: DB_OPTIONS, useValue: options }, DatabaseService, ], exports: [DatabaseService], }; } // Omitting module causes: // Error: The module at index [0] of the AppModule 'imports' array is undefined. module is the only required property — it must be the class reference, not a string. All other properties (imports, providers, exports, controllers, global) are optional. Properties in the returned object are merged with the class-level @Module() metadata. Setting global: true in the returned object makes this specific configuration instance global.

Difficulty: 5/10

Dynamic Modules, NestJS Module Metadata, Static forRoot pattern

The returned DynamicModule object must always include the module property set to the class itself. This is how NestJS identifies the module. All other properties (imports, providers, exports, controllers) are optional and extend the static module metadata. Omitting module produces a cryptic startup error.

Required module property in DynamicModule

DynamicModule return object rules:

1
module is the only required property — it must be the class reference, not a string.
2
All other properties (imports, providers, exports, controllers, global) are optional.
3
Properties in the returned object are merged with the class-level @Module() metadata.
4
Setting global: true in the returned object makes this specific configuration instance global.

Scenario Questions

0-2 years experience

Follow-up Questions