Global modules in NestJS - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is a global module in NestJS?

A global module is a module that is automatically available across the entire application without needing to import it in other modules.

beginner

How do you make a module global in NestJS?

You add the @Global() decorator above the module class and then export the providers you want to share.

intermediate

Why use global modules in NestJS?

Global modules help avoid repetitive imports of common services or providers in many modules, making code cleaner and easier to maintain.

intermediate

Can you import a global module multiple times in NestJS?

No, once a module is marked global, you do not need to import it in other modules. Importing it again has no effect.

beginner

Show a simple example of a global module in NestJS.

```typescript
import { Module, Global } from '@nestjs/common';

@Global()
@Module({
  providers: [CommonService],
  exports: [CommonService],
})
export class CommonModule {}
```

What decorator makes a module global in NestJS?

A @Module()

B @Global()

C @Injectable()

D @Controller()

The @Global() decorator marks a module as global so it can be used without importing it everywhere.

If a module is global, do you need to import it in every other module?

A Yes, always

B Only in controllers

C No, it is available automatically

D Only if it has providers

Global modules are automatically available in all modules without importing.

What must you do to share a service from a global module?

A Export the service in the module exports array

B Import the service in every module

C Use @Injectable() only

D Nothing, it is shared by default

You must export the service in the module's exports array to share it.

Which of these is NOT a benefit of global modules?

A Cleaner module code

B Make services available app-wide

C Avoid repetitive imports

D Automatically reload modules on change

Global modules do not affect module reloading behavior.

Where do you place the @Global() decorator?

A Above the module class

B Above the service class

C Inside the module imports array

D Inside the main.ts file

The @Global() decorator is placed above the module class declaration.

Explain how to create and use a global module in NestJS.

Think about how to share services app-wide without importing everywhere.

What are the advantages and possible downsides of using global modules in NestJS?

Consider both code simplicity and clarity.

Practice

1. What is the main purpose of marking a module with @Global() in NestJS?

easy

A. To disable dependency injection for the module

B. To make its providers available across the entire application without importing the module repeatedly

C. To automatically register the module as a controller

D. To restrict the module's providers to only one feature module

Solution

1. Step 1: Understand the role of @Global()

   The @Global() decorator marks a module so its providers can be used app-wide without importing it in every module.

2. Step 2: Compare options with this behavior

   Only To make its providers available across the entire application without importing the module repeatedly correctly describes this behavior; others describe unrelated or incorrect effects.

3. Final Answer:

   To make its providers available across the entire application without importing the module repeatedly -> Option B

4. Quick Check:

   Global modules share providers app-wide [OK]

Hint: Global modules share providers app-wide without imports [OK]

Common Mistakes:

• Thinking @Global restricts providers to one module
• Confusing @Global with controller registration
• Assuming @Global disables dependency injection

2. Which of the following is the correct way to declare a global module in NestJS?

easy

A. @Global() @Module({ providers: [MyService], exports: [MyService] }) export class MyModule {}

B. @Module({ global: true, providers: [MyService], exports: [MyService] }) export class MyModule {}

C. @GlobalModule() @Module({ providers: [MyService] }) export class MyModule {}

D. @Module({ providers: [MyService], global: true }) export class MyModule {}

Solution

1. Step 1: Recall the correct decorator for global modules

   In NestJS, @Global() is used above the module class to mark it global.

2. Step 2: Check syntax correctness

   @Global() @Module({ providers: [MyService], exports: [MyService] }) export class MyModule {} correctly uses @Global() and @Module() with providers and exports arrays.

3. Final Answer:

   @Global() @Module({ providers: [MyService], exports: [MyService] }) export class MyModule {} -> Option A

4. Quick Check:

   Use @Global() decorator above @Module() [OK]

Hint: Use @Global() decorator above @Module() to declare global module [OK]

Common Mistakes:

• Using 'global: true' inside @Module() which is invalid
• Using non-existent @GlobalModule() decorator
• Forgetting to export providers in global module

3. Given this global module declaration:

@Global()
@Module({
  providers: [ConfigService],
  exports: [ConfigService],
})
export class ConfigModule {}

What happens if another module imports ConfigModule again?

medium

A. The application will throw a runtime error due to duplicate imports

B. The providers from ConfigModule are duplicated and cause errors

C. The providers are shared globally, so importing again has no effect

D. The ConfigModule providers become private to the importing module

Solution

1. Step 1: Understand global module behavior on imports

   Global modules share their providers app-wide, so importing them multiple times does not duplicate providers.

2. Step 2: Analyze the effect of importing a global module again

   Importing a global module again is harmless; providers remain shared and singleton.

3. Final Answer:

   The providers are shared globally, so importing again has no effect -> Option C

4. Quick Check:

   Global modules share providers; repeated imports don't duplicate [OK]

Hint: Global modules share providers; repeated imports don't duplicate [OK]

Common Mistakes:

• Assuming repeated imports cause errors
• Thinking providers become private on re-import
• Confusing global modules with normal modules

4. Consider this code snippet:

@Global()
@Module({
  providers: [LoggerService],
  exports: [LoggerService],
})
export class LoggerModule {}

But when you try to inject LoggerService in another module, you get an error: Nest can't resolve dependencies. What is the likely cause?

medium

A. You forgot to import LoggerModule in the root module

B. You did not mark LoggerModule with @Global()

C. You forgot to export LoggerService from LoggerModule

D. You did not add @Injectable() to LoggerService

Solution

1. Step 1: Check the module declaration

   The module is marked global and exports LoggerService, so imports and exports are correct.

2. Step 2: Verify LoggerService setup

   If LoggerService lacks @Injectable(), NestJS cannot inject it, causing the error.

3. Final Answer:

   You did not add @Injectable() to LoggerService -> Option D

4. Quick Check:

   Missing @Injectable() on service causes injection errors [OK]

Hint: Check if service has @Injectable() decorator [OK]

Common Mistakes:

• Assuming global modules don't need imports anywhere
• Forgetting to export providers
• Confusing missing @Global() with injection errors

5. You want to create a global module that provides a configuration service with environment variables. Which of the following is the best practice to ensure the service is singleton and accessible everywhere without repeated imports?

hard

A. Mark the module with @Global(), export the service, and import it only once in the root module

B. Mark the module with @Global(), export the service, and import the module in every feature module

C. Mark the module with @Global(), export the service, and do not import it anywhere else

D. Do not mark the module global; import it in every module that needs it

Solution

1. Step 1: Understand global module usage

   Global modules provide their exported providers app-wide without needing to import them repeatedly.

2. Step 2: Determine import requirements for global modules

   Global modules must be imported once, typically in the root module; after that, providers are available app-wide without further imports.

3. Final Answer:

   Mark the module with @Global(), export the service, and import it only once in the root module -> Option A

4. Quick Check:

   Import global modules once in root module [OK]

Hint: Global modules: mark @Global(), export, import once in root [OK]

Common Mistakes:

• Importing global modules in every feature module
• Not importing global modules at all
• Not marking the module as global