ConfigModule setup in NestJS

Introduction

The ConfigModule helps your NestJS app read and manage settings easily. It keeps your app's configuration organized and safe.

You want to load environment variables like API keys or database URLs.

You need to share configuration settings across different parts of your app.

You want to keep sensitive data out of your code by using .env files.

You want to change settings without changing your code, like switching databases.

You want to validate your configuration to avoid errors.

Syntax

NestJS

import { ConfigModule } from '@nestjs/config';
import * as Joi from 'joi';

@Module({
  imports: [
    ConfigModule.forRoot({
      isGlobal: true, // optional
      envFilePath: '.env', // optional
      load: [configurationFunction], // optional
      validationSchema: Joi.object({}), // optional
    }),
  ],
})
export class AppModule {}

ConfigModule.forRoot() loads your config when the app starts.

Setting isGlobal: true makes config available everywhere without importing again.

Examples

Loads environment variables from a default .env file and makes config available locally.

NestJS

ConfigModule.forRoot()

Makes the config available in all modules without importing ConfigModule again.

NestJS

ConfigModule.forRoot({ isGlobal: true })

Loads environment variables from a custom file named .custom.env.

NestJS

ConfigModule.forRoot({ envFilePath: '.custom.env' })

Validates that DATABASE_URL is present and a string before app starts.

NestJS

ConfigModule.forRoot({
  validationSchema: Joi.object({
    DATABASE_URL: Joi.string().required(),
  }),
})

Sample Program

This example shows how to set up ConfigModule globally and use ConfigService to get a value.

NestJS

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

@Module({
  imports: [
    ConfigModule.forRoot({ isGlobal: true }),
  ],
})
export class AppModule {}

// Usage example in a service
import { Injectable } from '@nestjs/common';

@Injectable()
export class ExampleService {
  constructor(private configService: ConfigService) {}

  getDatabaseUrl(): string {
    return this.configService.get<string>('DATABASE_URL') || 'not set';
  }
}

// If .env contains DATABASE_URL=postgres://user:pass@localhost/db
// Then calling getDatabaseUrl() returns that string.

Important Notes

Always add a .env file to your .gitignore to keep secrets safe.

You can use validationSchema with Joi to catch missing or wrong config early.

Use ConfigService to access config values anywhere in your app.

Summary

ConfigModule helps manage app settings from environment variables.

Use forRoot() to load config and isGlobal: true to share it app-wide.

Access config values with ConfigService safely and easily.

Practice

1. What is the main purpose of ConfigModule in a NestJS application?

easy

A. To manage application settings using environment variables

B. To handle HTTP requests and responses

C. To connect to a database

D. To create middleware for logging

Solution

1. Step 1: Understand ConfigModule role

   The ConfigModule is designed to load and manage configuration settings, often from environment variables.

2. Step 2: Compare with other options

   Options A, B, and D relate to other parts of NestJS like database connections, HTTP handling, and middleware, not configuration management.

3. Final Answer:

   To manage application settings using environment variables -> Option A

4. Quick Check:

   ConfigModule = Manage app settings [OK]

Hint: ConfigModule is for app settings, not HTTP or DB [OK]

Common Mistakes:

• Confusing ConfigModule with database modules
• Thinking ConfigModule handles HTTP requests
• Assuming ConfigModule creates middleware

2. Which is the correct way to import ConfigModule globally in the root module?

easy

A. ConfigModule.register({ global: true })

B. ConfigModule.forFeature({ isGlobal: true })

C. ConfigModule.forRoot({ isGlobal: true })

D. ConfigModule.global()

Solution

1. Step 1: Recall ConfigModule global setup syntax

   To make ConfigModule available app-wide, use forRoot() with isGlobal: true.

2. Step 2: Check other options for correctness

   forFeature() is for scoped configs, register() and global() are not valid methods here.

3. Final Answer:

   ConfigModule.forRoot({ isGlobal: true }) -> Option C

4. Quick Check:

   Global config = forRoot + isGlobal true [OK]

Hint: Use forRoot with isGlobal true for global config [OK]

Common Mistakes:

• Using forFeature instead of forRoot
• Trying to use non-existent methods like global()
• Confusing register with forRoot

3. Given this code snippet in a NestJS service:

constructor(private configService: ConfigService) {}

getDbHost() {
  return this.configService.get('DATABASE_HOST');
}

What will getDbHost() return if DATABASE_HOST is set to "localhost" in the environment?

medium

A. Throws an error

B. undefined

C. null

D. "localhost"

Solution

1. Step 1: Understand ConfigService.get behavior

   The get method returns the value of the environment variable if set, here 'localhost'.

2. Step 2: Check environment variable presence

   Since DATABASE_HOST is set to 'localhost', the method returns that string, not undefined or null.

3. Final Answer:

   "localhost" -> Option D

4. Quick Check:

   Env var set = get returns value [OK]

Hint: get() returns env value if set, else undefined [OK]

Common Mistakes:

• Assuming get returns null if variable exists
• Expecting an error if variable is missing
• Confusing undefined with null

4. Identify the error in this NestJS module setup:

@Module({
  imports: [ConfigModule.forRoot({ isGlobal: true })],
  providers: [ConfigService],
})
export class AppModule {}

medium

A. ConfigService should not be listed in providers when ConfigModule is global

B. Missing import of ConfigService from '@nestjs/config'

C. forRoot() should not have isGlobal option

D. ConfigModule should be imported in controllers, not imports

Solution

1. Step 1: Understand global ConfigModule behavior

   When isGlobal: true is set, ConfigService is automatically provided app-wide, no need to add it manually.

2. Step 2: Check other options for validity

   Importing ConfigService is not mandatory in module file, forRoot supports isGlobal, and ConfigModule belongs in imports array.

3. Final Answer:

   ConfigService should not be listed in providers when ConfigModule is global -> Option A

4. Quick Check:

   Global ConfigModule auto-provides ConfigService [OK]

Hint: Don't add ConfigService to providers if ConfigModule is global [OK]

Common Mistakes:

• Adding ConfigService to providers unnecessarily
• Thinking isGlobal is invalid option
• Placing ConfigModule in controllers array

5. You want to load a custom configuration file named custom.env using ConfigModule and make it global. Which setup is correct?

hard

A. ConfigModule.forRoot({ envFileName: 'custom.env', global: true })

B. ConfigModule.forRoot({ envFilePath: 'custom.env', isGlobal: true })

C. ConfigModule.forFeature({ envFilePath: 'custom.env', isGlobal: true })

D. ConfigModule.register({ envFilePath: 'custom.env', isGlobal: true })

Solution

1. Step 1: Identify correct option names for ConfigModule

   The correct option to specify a custom env file is envFilePath, and to make it global use isGlobal: true inside forRoot().

2. Step 2: Eliminate incorrect options

   envFileName and global are invalid option names; forFeature and register are not used for global config loading.

3. Final Answer:

   ConfigModule.forRoot({ envFilePath: 'custom.env', isGlobal: true }) -> Option B

4. Quick Check:

   Custom env + global = envFilePath + isGlobal true [OK]

Hint: Use envFilePath and isGlobal in forRoot for custom global config [OK]

Common Mistakes:

• Using envFileName instead of envFilePath
• Trying to use forFeature for global config
• Using register instead of forRoot