Dynamic modules in NestJS - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a dynamic module in NestJS?

A dynamic module is a module that can be configured and created at runtime with custom providers, imports, and exports. It allows flexibility to pass parameters and create reusable modules.

intermediate

How do you define a dynamic module in NestJS?

You define a dynamic module by creating a static method (usually called forRoot or forFeature) that returns a DynamicModule object with metadata like providers, imports, and exports based on passed options.

beginner

Why use dynamic modules instead of static modules?

Dynamic modules let you customize module behavior and dependencies at runtime, making your code more flexible and reusable for different configurations or environments.

intermediate

What is the typical signature of a dynamic module factory method?

It is a static method that accepts options as parameters and returns an object with the shape: { module: YourModule, providers: [...], exports: [...], imports?: [...] }.

beginner

Can dynamic modules import other modules in NestJS?

Yes, dynamic modules can import other modules dynamically by including them in the imports array of the returned module metadata.

What does a dynamic module factory method usually return?

A A string with module name

B A plain JavaScript object without module info

C A function that runs on app start

D An object with module metadata including providers and exports

A dynamic module factory method returns an object describing the module, including providers, imports, and exports.

Which keyword is used to define a dynamic module factory method in NestJS?

A static

B async

C private

D export

The factory method is defined as a static method so it can be called without creating an instance.

Why might you use a dynamic module in NestJS?

A To write less code by skipping imports

B To avoid using modules altogether

C To configure module providers based on runtime options

D To make modules static and fixed

Dynamic modules allow configuration of providers and imports based on options passed at runtime.

Which of these is NOT part of a dynamic module's returned object?

A components

B module

C exports

D providers

The returned object includes module, providers, imports, and exports, but not components.

Can dynamic modules be reused with different configurations?

A Only if you use global modules

B Yes, by passing different options to the factory method

C Only if you restart the app

D No, they are fixed once created

Dynamic modules are designed to be reusable with different configurations by passing options.

Explain how to create a dynamic module in NestJS and why it is useful.

Think about how you can pass options to customize a module.

Describe the structure of the object returned by a dynamic module's factory method.

What does NestJS expect to know about the module?

Practice

1. What is the main purpose of a dynamic module in NestJS?

easy

A. To automatically generate database schemas

B. To create modules without any providers or exports

C. To replace the need for controllers in an application

D. To allow configuration of modules with custom options at runtime

Solution

1. Step 1: Understand dynamic module concept

   Dynamic modules let you pass custom options to configure the module when importing it.

2. Step 2: Identify the main purpose

   This flexibility helps reuse modules with different settings instead of hardcoding them.

3. Final Answer:

   To allow configuration of modules with custom options at runtime -> Option D

4. Quick Check:

   Dynamic modules = configurable modules [OK]

Hint: Dynamic modules customize modules with options [OK]

Common Mistakes:

• Thinking dynamic modules remove controllers
• Believing dynamic modules auto-generate schemas
• Assuming dynamic modules have no providers

2. Which of the following is the correct way to define a dynamic module method in NestJS?

easy

A. constructor(options: ModuleOptions): void { ... }

B. static forRoot(options: ModuleOptions): DynamicModule { ... }

C. export function createModule(options: ModuleOptions) { ... }

D. async initialize(options: ModuleOptions): Promise<void> { ... }

Solution

1. Step 1: Recall dynamic module pattern

   Dynamic modules use a static method, commonly named forRoot, returning a DynamicModule object.

2. Step 2: Match method signature

   Only a static method can be called without creating an instance, fitting the dynamic module pattern.

3. Final Answer:

   static forRoot(options: ModuleOptions): DynamicModule { ... } -> Option B

4. Quick Check:

   Dynamic module method = static forRoot [OK]

Hint: Dynamic modules use static forRoot method [OK]

Common Mistakes:

• Using constructor instead of static method
• Defining dynamic module as a normal function
• Making dynamic module method async without returning DynamicModule

3. Given this dynamic module code, what will be the value of the exported provider's token?

export class LoggerModule {
  static forRoot(prefix: string): DynamicModule {
    return {
      module: LoggerModule,
      providers: [
        { provide: 'LOGGER_PREFIX', useValue: prefix },
      ],
      exports: ['LOGGER_PREFIX'],
    };
  }
}

medium

A. 'prefix'

B. 'LoggerModule'

C. 'LOGGER_PREFIX'

D. 'useValue'

Solution

1. Step 1: Identify provider token

   The provider uses the key 'provide' with value 'LOGGER_PREFIX' which is the token for injection.

2. Step 2: Confirm exported token

   The exports array includes 'LOGGER_PREFIX', so this token is available outside the module.

3. Final Answer:

   'LOGGER_PREFIX' -> Option C

4. Quick Check:

   Provider token = 'LOGGER_PREFIX' [OK]

Hint: Provider token is the 'provide' string value [OK]

Common Mistakes:

• Confusing module name with provider token
• Using variable name 'prefix' as token
• Thinking useValue is the token

4. Identify the error in this dynamic module definition:

export class CacheModule {
  static forRoot(options: { ttl: number }): DynamicModule {
    return {
      module: CacheModule,
      providers: [
        { provide: 'CACHE_TTL', useFactory: (options) => options.ttl },
      ],
      exports: ['CACHE_TTL'],
    };
  }
}

medium

A. The useFactory function cannot access options parameter directly

B. The module property should be a string, not a class

C. Exports array must include providers, not strings

D. Static methods cannot return DynamicModule

Solution

1. Step 1: Analyze useFactory context

   The useFactory function runs later and cannot directly access the outer options variable without injection.

2. Step 2: Identify correct pattern

   To use options inside useFactory, it must be passed via inject or closure properly; direct access causes runtime error.

3. Final Answer:

   The useFactory function cannot access options parameter directly -> Option A

4. Quick Check:

   useFactory needs inject or closure for options [OK]

Hint: useFactory can't directly use outer variables [OK]

Common Mistakes:

• Thinking module property must be string
• Believing exports must list provider objects
• Assuming static methods can't return DynamicModule

5. You want to create a dynamic module that accepts a configuration object and provides two services using that config. Which approach correctly implements this pattern?

hard

A. Use a static forRoot method returning a DynamicModule with providers using useValue for config and export both services

B. Create a constructor in the module class that sets config and exports services directly

C. Define services inside the module without any configuration and import them normally

D. Use a global module without any providers and configure services externally

Solution

1. Step 1: Understand dynamic module pattern for config

   Dynamic modules use a static method (like forRoot) to accept config and return a DynamicModule object with providers.

2. Step 2: Provide config and services properly

   Use useValue or useFactory to inject config into providers, and export services to make them available outside.

3. Final Answer:

   Use a static forRoot method returning a DynamicModule with providers using useValue for config and export both services -> Option A

4. Quick Check:

   Dynamic module with static forRoot and providers = Use a static forRoot method returning a DynamicModule with providers using useValue for config and export both services [OK]

Hint: Use static forRoot with providers and exports [OK]

Common Mistakes:

• Trying to configure modules via constructor
• Not exporting services after providing them
• Using global module without providers for config