Environment variables in NestJS

Introduction

Environment variables help you keep important settings outside your code. This makes your app flexible and safe.

You want to keep secret keys like API tokens safe.

You need to change settings like database address without changing code.

You want to run the same app on your computer and on a server with different settings.

You want to avoid hardcoding values that might change later.

Syntax

NestJS

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

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

// Accessing environment variable inside a class
constructor(private configService: ConfigService) {}

const value = this.configService.get<string>('VARIABLE_NAME');

Use ConfigModule.forRoot() to load variables from a .env file automatically.

Access variables using ConfigService.get() inside your classes.

Examples

This makes the config available everywhere without importing again.

NestJS

ConfigModule.forRoot({ isGlobal: true })

Get the PORT variable, or use 3000 if not set.

NestJS

const port = this.configService.get<number>('PORT', 3000);

Put your environment variables in a .env file at the project root.

NestJS

DATABASE_URL=postgres://user:pass@localhost/dbname

# .env file example

Sample Program

This example shows how to load environment variables globally and access the DATABASE_URL variable inside a service.

NestJS

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

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

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

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

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

// Assume .env file contains:
// DATABASE_URL=postgres://user:pass@localhost/dbname

Important Notes

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

You can define default values when accessing variables to avoid errors.

Use descriptive variable names to remember what each setting does.

Summary

Environment variables keep settings outside your code for safety and flexibility.

Use ConfigModule and ConfigService in NestJS to work with them easily.

Put variables in a .env file and load them with ConfigModule.forRoot().

Practice

1. What is the main purpose of using environment variables in a NestJS application?

easy

A. To hardcode sensitive data like passwords in the source code

B. To write all configuration directly inside the main application file

C. To make the application run faster by avoiding configuration files

D. To keep configuration settings outside the code for security and flexibility

Solution

1. Step 1: Understand environment variables purpose

   Environment variables store settings like API keys or database URLs outside the code to keep them safe and easy to change.

2. Step 2: Compare options

   Only To keep configuration settings outside the code for security and flexibility correctly describes this purpose. Options A and B suggest unsafe practices, and D is incorrect about performance.

3. Final Answer:

   To keep configuration settings outside the code for security and flexibility -> Option D

4. Quick Check:

   Environment variables = external safe config [OK]

Hint: Environment variables keep secrets out of code [OK]

Common Mistakes:

• Hardcoding sensitive data inside source code
• Confusing environment variables with regular variables
• Thinking environment variables improve speed

2. Which of the following is the correct way to load environment variables in a NestJS app?

easy

A. Manually read .env file using fs module in every service

B. Use process.env directly without any module

C. Import ConfigModule with ConfigModule.forRoot() in the root module

D. Declare environment variables inside main.ts without ConfigModule

Solution

1. Step 1: Identify NestJS recommended method

   NestJS uses ConfigModule.forRoot() to load .env files and provide ConfigService.

2. Step 2: Evaluate other options

   Options A and C are possible but not recommended patterns. Declare environment variables inside main.ts without ConfigModule is incorrect because environment variables are external.

3. Final Answer:

   Import ConfigModule with ConfigModule.forRoot() in the root module -> Option C

4. Quick Check:

   ConfigModule.forRoot() loads env [OK]

Hint: Use ConfigModule.forRoot() to load .env [OK]

Common Mistakes:

• Reading .env manually everywhere
• Ignoring ConfigModule and using process.env directly
• Declaring env variables inside code files

3. Given this code snippet in a NestJS service:

constructor(private configService: ConfigService) {}

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

If the .env file contains DATABASE_HOST=localhost, what will getDbHost() return?

medium

A. undefined

B. localhost

C. DATABASE_HOST

D. null

Solution

1. Step 1: Understand ConfigService.get() behavior

   ConfigService.get('DATABASE_HOST') reads the value of DATABASE_HOST from loaded environment variables.

2. Step 2: Match with .env content

   The .env file sets DATABASE_HOST=localhost, so the method returns 'localhost'.

3. Final Answer:

   localhost -> Option B

4. Quick Check:

   ConfigService.get('DATABASE_HOST') = 'localhost' [OK]

Hint: ConfigService.get returns env value by key [OK]

Common Mistakes:

• Expecting the key name instead of value
• Assuming undefined if ConfigModule not imported
• Confusing null with undefined

4. What is wrong with this NestJS module setup for environment variables?

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

medium

A. ConfigModule is imported without calling forRoot(), so env variables won't load

B. ConfigModule should be imported in providers, not imports

C. ConfigModule requires a .json config file, not .env

D. ConfigModule must be imported twice to work

Solution

1. Step 1: Check ConfigModule import syntax

   ConfigModule must be imported with forRoot() to load environment variables from .env file.

2. Step 2: Identify error in code

   The code imports ConfigModule directly without forRoot(), so env variables won't be loaded.

3. Final Answer:

   ConfigModule is imported without calling forRoot(), so env variables won't load -> Option A

4. Quick Check:

   ConfigModule.forRoot() needed to load env [OK]

Hint: Always use ConfigModule.forRoot() to load env [OK]

Common Mistakes:

• Importing ConfigModule without forRoot()
• Placing ConfigModule in providers instead of imports
• Thinking ConfigModule needs JSON config

5. You want to provide a default value for an environment variable PORT in NestJS if it is not set in the .env file. Which code snippet correctly achieves this in a service?

hard

A. const port = this.configService.get('PORT') || 3000;

B. const port = process.env.PORT ? 3000 : this.configService.get('PORT');

C. const port = this.configService.get('PORT', 3000);

D. const port = this.configService.get('PORT') && 3000;

Solution

1. Step 1: Understand default value logic

   If PORT is undefined or empty, use 3000 as default. Logical OR (||) works for this.

2. Step 2: Analyze options

   const port = this.configService.get('PORT') || 3000; uses || to provide default 3000 if get('PORT') is falsy. const port = process.env.PORT ? 3000 : this.configService.get('PORT'); reverses logic incorrectly. const port = this.configService.get('PORT', 3000); is invalid because get() does not take default param. const port = this.configService.get('PORT') && 3000; uses && which returns 3000 only if PORT is truthy, wrong logic.

3. Final Answer:

   const port = this.configService.get('PORT') || 3000; -> Option A

4. Quick Check:

   Use || to set default value [OK]

Hint: Use || to set default if env variable missing [OK]

Common Mistakes:

• Using && instead of || for default
• Passing default value as second argument to get()
• Reversing condition logic