Module re-exporting in NestJS

Introduction

Module re-exporting helps share features from one module to others easily. It avoids repeating imports everywhere.

You want to group several modules and share them as one package.

You want to hide internal modules but expose only some parts to other modules.

You want to simplify imports in big projects by creating a shared module.

You want to reuse common services or components across many modules.

You want to organize your code better by controlling what is visible outside.

Syntax

NestJS

import { Module } from '@nestjs/common';
import { SomeModule } from './some.module';

@Module({
  imports: [SomeModule],
  exports: [SomeModule],
})
export class SharedModule {}

The imports array brings in the module you want to re-export.

The exports array makes that module available to others importing this module.

Examples

This example re-exports UsersModule so other modules can import SharedModule to get UsersModule features.

NestJS

import { Module } from '@nestjs/common';
import { UsersModule } from './users.module';

@Module({
  imports: [UsersModule],
  exports: [UsersModule],
})
export class SharedModule {}

This example groups two modules and re-exports them together as CoreModule.

NestJS

import { Module } from '@nestjs/common';
import { UsersModule } from './users.module';
import { AuthModule } from './auth.module';

@Module({
  imports: [UsersModule, AuthModule],
  exports: [UsersModule, AuthModule],
})
export class CoreModule {}

This example re-exports a configured module so other modules get the same config by importing SharedConfigModule.

NestJS

import { Module } from '@nestjs/common';
import { ConfigModule } from '@nestjs/config';

@Module({
  imports: [ConfigModule.forRoot()],
  exports: [ConfigModule],
})
export class SharedConfigModule {}

Sample Program

This example shows a LoggerService inside LoggerModule. Then LoggerModule is re-exported by SharedModule. Finally, AppModule imports SharedModule and uses LoggerService in AppController. This way, the logger is shared without importing LoggerModule directly.

NestJS

import { Module, Injectable } from '@nestjs/common';

@Injectable()
export class LoggerService {
  log(message: string) {
    console.log('Log:', message);
  }
}

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

@Module({
  imports: [LoggerModule],
  exports: [LoggerModule],
})
export class SharedModule {}

import { Controller, Get } from '@nestjs/common';

@Controller()
export class AppController {
  constructor(private logger: LoggerService) {}

  @Get()
  getHello(): string {
    this.logger.log('Hello endpoint called');
    return 'Hello World';
  }
}

@Module({
  imports: [SharedModule],
  controllers: [AppController],
})
export class AppModule {}

Important Notes

Re-exporting only works if you add the module to both imports and exports.

Use re-exporting to keep your module imports clean and organized.

Remember to export providers or modules you want others to use.

Summary

Module re-exporting shares modules easily by importing and exporting them in one place.

It helps keep code organized and reduces repeated imports.

Use it to group common modules or services for easy reuse.

Practice

1. What is the main purpose of module re-exporting in NestJS?

easy

A. To share modules through another module for better organization

B. To create multiple instances of the same module

C. To prevent modules from being imported anywhere

D. To automatically generate services inside a module

Solution

1. Step 1: Understand module re-exporting concept

   Module re-exporting allows one module to share its imported modules with other modules by re-exporting them.

2. Step 2: Identify the purpose in NestJS

   This helps keep the app organized and makes modules easier to maintain by avoiding repeated imports.

3. Final Answer:

   To share modules through another module for better organization -> Option A

4. Quick Check:

   Module re-exporting = sharing modules [OK]

Hint: Re-exporting means sharing modules via another module [OK]

Common Mistakes:

• Thinking re-exporting creates new module instances
• Believing it blocks module imports
• Confusing it with automatic service generation

2. Which syntax correctly re-exports a module named SharedModule inside another module's decorator?

easy

A. @Module({ exports: [SharedModule] })

B. @Module({ imports: [], exports: [SharedModule] })

C. @Module({ imports: [SharedModule] })

D. @Module({ imports: [SharedModule], exports: [SharedModule] })

Solution

1. Step 1: Recall NestJS module decorator structure

   To re-export a module, it must be both imported and exported in the module decorator.

2. Step 2: Check each option

   The syntax with both imports: [SharedModule] and exports: [SharedModule] is correct. Syntaxes missing either array are incorrect.

3. Final Answer:

   @Module({ imports: [SharedModule], exports: [SharedModule] }) -> Option D

4. Quick Check:

   Import and export to re-export [OK]

Hint: Re-export needs both imports and exports arrays [OK]

Common Mistakes:

• Only exporting without importing
• Only importing without exporting
• Leaving either array empty when re-exporting

3. Given these modules, what will be the output of console.log(appModuleImports) if AppModule imports CoreModule which re-exports SharedModule?

@Module({ imports: [SharedModule], exports: [SharedModule] })
export class CoreModule {}

@Module({ imports: [CoreModule] })
export class AppModule {}

Assuming appModuleImports is the list of modules available inside AppModule.

medium

A. [SharedModule]

B. [CoreModule, SharedModule]

C. [CoreModule]

D. []

Solution

1. Step 1: Understand re-export effect on imports

   CoreModule imports and exports SharedModule, so any module importing CoreModule also gets SharedModule.

2. Step 2: Analyze AppModule imports

   AppModule imports CoreModule, so it has access to both CoreModule and SharedModule.

3. Final Answer:

   [CoreModule, SharedModule] -> Option B

4. Quick Check:

   Re-exported modules appear in importing module imports [OK]

Hint: Re-exported modules appear as if directly imported [OK]

Common Mistakes:

• Assuming only CoreModule is available
• Thinking SharedModule is hidden
• Ignoring exports array effect

4. Identify the error in this module re-exporting code:

@Module({
  imports: [SharedModule],
  exports: []
})
export class CoreModule {}

medium

A. SharedModule is imported but not exported, so it is not re-exported

B. SharedModule should not be in imports when re-exporting

C. exports array cannot be empty in any module

D. CoreModule must import AppModule to re-export SharedModule

Solution

1. Step 1: Check imports and exports arrays

   SharedModule is imported but not exported, so CoreModule does not re-export it.

2. Step 2: Understand re-export requirement

   To re-export a module, it must be listed in both imports and exports arrays.

3. Final Answer:

   SharedModule is imported but not exported, so it is not re-exported -> Option A

4. Quick Check:

   Re-export needs both imports and exports [OK]

Hint: Exports must include imported modules to re-export [OK]

Common Mistakes:

• Leaving exports empty when re-exporting
• Confusing imports-only as re-export
• Thinking exports array is optional

5. You have three modules: SharedModule, CoreModule, and FeatureModule. CoreModule imports and re-exports SharedModule. FeatureModule imports CoreModule. How can you modify FeatureModule to also re-export SharedModule without importing it directly?

hard

A. Add imports: [SharedModule] in FeatureModule

B. Add exports: [SharedModule] in FeatureModule

C. Add exports: [CoreModule] in @Module decorator of FeatureModule

D. Add providers: [SharedModule] in FeatureModule

Solution

1. Step 1: Understand re-export chaining

   FeatureModule imports CoreModule, which re-exports SharedModule, so FeatureModule has access to SharedModule.

2. Step 2: Re-export SharedModule via CoreModule

   To re-export SharedModule from FeatureModule without importing it directly, FeatureModule must export CoreModule.

3. Final Answer:

   Add exports: [CoreModule] in @Module decorator of FeatureModule -> Option C

4. Quick Check:

   Export imported module to re-export its exports [OK]

Hint: Export imported module to re-export its exports [OK]

Common Mistakes:

• Trying to export SharedModule without importing it
• Adding SharedModule to providers array
• Importing SharedModule directly instead of re-exporting