Feature modules in NestJS

Introduction

Feature modules help organize your NestJS app by grouping related code together. This makes your app easier to understand and maintain.

When you want to separate different parts of your app, like users, products, or orders.

When your app grows and you need to keep code organized and manageable.

When you want to reuse a group of related services and controllers in different parts of your app.

When you want to load parts of your app only when needed to improve performance.

Syntax

NestJS

import { Module } from '@nestjs/common';
import { SomeService } from './some.service';
import { SomeController } from './some.controller';

@Module({
  imports: [],
  controllers: [SomeController],
  providers: [SomeService],
  exports: [SomeService],
})
export class SomeModule {}

The @Module decorator defines a feature module.

You list controllers, providers (services), and other modules inside the decorator.

Examples

This is a simple feature module for user-related code.

NestJS

import { Module } from '@nestjs/common';
import { UsersService } from './users.service';
import { UsersController } from './users.controller';

@Module({
  controllers: [UsersController],
  providers: [UsersService],
})
export class UsersModule {}

This module imports a database entity and exports its service for use in other modules.

NestJS

import { Module } from '@nestjs/common';
import { TypeOrmModule } from '@nestjs/typeorm';
import { Product } from './product.entity';
import { ProductsService } from './products.service';
import { ProductsController } from './products.controller';

@Module({
  imports: [TypeOrmModule.forFeature([Product])],
  controllers: [ProductsController],
  providers: [ProductsService],
  exports: [ProductsService],
})
export class ProductsModule {}

Sample Program

This feature module groups the cats controller and service. The controller uses the service to return a list of cat names when you visit the '/cats' route.

NestJS

import { Module } from '@nestjs/common';
import { CatsController } from './cats.controller';
import { CatsService } from './cats.service';

@Module({
  controllers: [CatsController],
  providers: [CatsService],
  exports: [CatsService],
})
export class CatsModule {}

// cats.service.ts
import { Injectable } from '@nestjs/common';

@Injectable()
export class CatsService {
  getCats() {
    return ['Tom', 'Jerry', 'Garfield'];
  }
}

// cats.controller.ts
import { Controller, Get } from '@nestjs/common';
import { CatsService } from './cats.service';

@Controller('cats')
export class CatsController {
  constructor(private readonly catsService: CatsService) {}

  @Get()
  findAll() {
    return this.catsService.getCats();
  }
}

Important Notes

Feature modules help keep your app code clean and organized.

Use the exports array to share providers with other modules.

Import feature modules into your root module or other feature modules to use their functionality.

Summary

Feature modules group related controllers and services.

They make your app easier to manage and scale.

Use @Module decorator to define them.

Practice

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

easy

A. To manage HTTP requests without controllers

B. To group related controllers and services for better organization

C. To replace the main application module

D. To handle database connections directly

Solution

1. Step 1: Understand the role of feature modules

   Feature modules group related parts of the app like controllers and services to keep code organized.

2. Step 2: Compare options with this role

   Only To group related controllers and services for better organization describes grouping related controllers and services, which matches the purpose.

3. Final Answer:

   To group related controllers and services for better organization -> Option B

4. Quick Check:

   Feature modules organize code = D [OK]

Hint: Feature modules group related parts of your app [OK]

Common Mistakes:

• Thinking feature modules handle database connections directly
• Confusing feature modules with the main app module
• Assuming feature modules replace controllers

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

easy

A. @Controller({}) export class FeatureModule {}

B. @Injectable() export class FeatureModule {}

C. @Module({ controllers: [], providers: [] }) export class FeatureModule {}

D. export class FeatureModule {}

Solution

1. Step 1: Recall the decorator for modules

   Feature modules use the @Module decorator with metadata like controllers and providers.

2. Step 2: Match options with correct decorator

   Only @Module({ controllers: [], providers: [] }) export class FeatureModule {} uses @Module with controllers and providers arrays, which is correct syntax.

3. Final Answer:

   @Module({ controllers: [], providers: [] }) export class FeatureModule {} -> Option C

4. Quick Check:

   @Module decorator defines modules = B [OK]

Hint: Use @Module decorator with controllers and providers [OK]

Common Mistakes:

• Using @Controller or @Injectable instead of @Module
• Forgetting to add the decorator
• Defining empty classes without decorators

3. Given this feature module code, what will be the output when the getHello() method is called from HelloController?

@Module({
  controllers: [HelloController],
  providers: [HelloService],
})
export class HelloModule {}

@Injectable()
export class HelloService {
  getHello() {
    return 'Hello from service!';
  }
}

@Controller()
export class HelloController {
  constructor(private readonly helloService: HelloService) {}

  @Get()
  getHello() {
    return this.helloService.getHello();
  }
}

medium

A. undefined

B. "Hello from controller!"

C. Runtime error due to missing provider

D. "Hello from service!"

Solution

1. Step 1: Understand dependency injection in the module

   The HelloService is provided in the module and injected into HelloController.

2. Step 2: Trace the method call

   The controller's getHello calls helloService.getHello(), which returns 'Hello from service!'.

3. Final Answer:

   "Hello from service!" -> Option D

4. Quick Check:

   Service method returns string = C [OK]

Hint: Controller calls service method returning string [OK]

Common Mistakes:

• Assuming controller returns its own string
• Thinking provider is missing causing error
• Confusing method names or return values

4. Identify the error in this feature module definition:

@Module({
  controllers: [UserController],
  providers: [UserService],
})
export class UserModule {}

@Injectable()
export class UserService {}

@Controller()
export class UserController {
  constructor(userService: UserService) {}
}

medium

A. Missing access modifier 'private' in constructor injection

B. UserService is not decorated with @Injectable()

C. UserController is missing @Controller() decorator

D. UserService is not listed in providers array

Solution

1. Step 1: Check constructor injection syntax

   In NestJS, injected dependencies must have an access modifier like private or public to create a class property.

2. Step 2: Identify the missing modifier

   The constructor parameter 'userService' lacks 'private' or 'public', so it won't be assigned automatically.

3. Final Answer:

   Missing access modifier 'private' in constructor injection -> Option A

4. Quick Check:

   Constructor injection needs access modifier = A [OK]

Hint: Constructor injection needs private/public keyword [OK]

Common Mistakes:

• Forgetting private/public in constructor parameters
• Assuming @Injectable is missing when it is present
• Confusing decorator placement

5. You want to create a feature module that imports another feature module to reuse its services. Which of the following is the correct way to import AuthModule into UserModule?

hard

A. @Module({ imports: [AuthModule], controllers: [UserController], providers: [UserService] }) export class UserModule {}

B. @Module({ controllers: [UserController], providers: [UserService] }) export class UserModule { constructor(private authModule: AuthModule) {} }

C. @Module({ exports: [AuthModule], controllers: [UserController], providers: [UserService] }) export class UserModule {}

D. @Module({ imports: [], controllers: [UserController], providers: [UserService] }) export class UserModule {}

Solution

1. Step 1: Understand module imports in NestJS

   To reuse services from another module, you must import that module in the imports array.

2. Step 2: Identify correct import usage

   @Module({ imports: [AuthModule], controllers: [UserController], providers: [UserService] }) export class UserModule {} correctly adds AuthModule to imports, allowing UserModule to use its exported providers.

3. Final Answer:

   @Module({ imports: [AuthModule], controllers: [UserController], providers: [UserService] }) export class UserModule {} -> Option A

4. Quick Check:

   Import modules via imports array = A [OK]

Hint: Use imports array to include other feature modules [OK]

Common Mistakes:

• Trying to inject modules via constructor instead of imports
• Using exports instead of imports to include modules
• Leaving imports array empty when reusing modules