Configuration namespaces in NestJS - Mini Project: Build & Apply

Using Configuration Namespaces in NestJS

📖 Scenario: You are building a NestJS application that needs to manage different configuration settings for database and API. To keep things organized, you will use configuration namespaces.

🎯 Goal: Create a NestJS configuration setup that uses namespaces to separate database and api settings, then access these settings in a service.

📋 What You'll Learn

Create a configuration object with database and api namespaces

Add a configuration module using ConfigModule.forRoot() with the namespaces

Access the database.host and api.key values in a service using ConfigService

Use the namespaces properly to retrieve the correct configuration values

💡 Why This Matters

🌍 Real World

Many real-world NestJS applications need to organize configuration settings for different parts like database, API, and authentication. Using namespaces keeps these settings clear and manageable.

💼 Career

Understanding configuration namespaces and how to access them is important for backend developers working with NestJS to build scalable and maintainable applications.

1

Create configuration namespaces

Create a constant called configuration that returns an object with two namespaces: database containing host set to 'localhost' and port set to 5432, and api containing key set to '12345' and timeout set to 5000.

NestJS

# Your code here

Hint

Use a function that returns an object with database and api keys, each having their own settings.

2

Configure ConfigModule with namespaces

Import ConfigModule from @nestjs/config and call ConfigModule.forRoot() with the load option set to an array containing the configuration function.

NestJS

const configuration = () => ({
  database: {
    host: 'localhost',
    port: 5432
  },
  api: {
    key: '12345',
    timeout: 5000
  }
});

// Import ConfigModule and configure it with the configuration function
// Your code here

Hint

Use ConfigModule.forRoot() and pass load with your configuration function inside an array.

3

Access configuration values in a service

Create a class called AppService with a constructor that injects ConfigService from @nestjs/config. Inside the class, create a method getDatabaseHost() that returns the database host by calling this.configService.get('database.host'), and a method getApiKey() that returns the API key by calling this.configService.get('api.key').

NestJS

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

const configuration = () => ({
  database: {
    host: 'localhost',
    port: 5432
  },
  api: {
    key: '12345',
    timeout: 5000
  }
});

ConfigModule.forRoot({
  load: [configuration]
});

// Create AppService class with constructor injecting ConfigService
// Add getDatabaseHost() and getApiKey() methods
// Your code here

Hint

Inject ConfigService in the constructor and use get() with the full path to access nested config values.

4

Complete module setup with ConfigModule import

Create a class called AppModule decorated with @Module from @nestjs/common. Inside the decorator, add imports with an array containing ConfigModule.forRoot({ load: [configuration] }), and providers with an array containing AppService.

NestJS

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

const configuration = () => ({
  database: {
    host: 'localhost',
    port: 5432
  },
  api: {
    key: '12345',
    timeout: 5000
  }
});

ConfigModule.forRoot({
  load: [configuration]
});

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

  getDatabaseHost(): string {
    return this.configService.get('database.host');
  }

  getApiKey(): string {
    return this.configService.get('api.key');
  }
}

// Create AppModule with @Module decorator
// Add ConfigModule.forRoot with load option and AppService provider
// Your code here

Hint

Use the @Module decorator to import ConfigModule.forRoot() with your configuration and provide AppService.

Practice

1. What is the main purpose of using registerAs in NestJS configuration?

easy

A. To create a database connection

B. To register a global middleware in the application

C. To define a new module in NestJS

D. To create a named namespace grouping related configuration settings

Solution

1. Step 1: Understand the role of registerAs

   registerAs is used to define a configuration namespace, grouping related settings under one name.

2. Step 2: Differentiate from other NestJS features

   It is not used for middleware, modules, or database connections, which are handled differently.

3. Final Answer:

   To create a named namespace grouping related configuration settings -> Option D

4. Quick Check:

   registerAs creates config namespaces = A [OK]

Hint: Remember: registerAs groups config keys under one name [OK]

Common Mistakes:

• Confusing registerAs with module registration
• Thinking registerAs sets up middleware
• Assuming registerAs creates database connections

2. Which of the following is the correct syntax to create a configuration namespace called 'database' using registerAs?

easy

A. export const database = registerAs('database', () => ({ host: 'localhost' }));

B. registerAs('database', { host: 'localhost' });

C. export default registerAs('database', () => ({ host: 'localhost' }));

D. registerAs('database', () => { host: 'localhost' });

Solution

1. Step 1: Check correct export and function syntax

   The correct pattern is to export a constant assigned to registerAs with a name and a function returning an object.

2. Step 2: Identify syntax errors in options

   export default registerAs('database', () => ({ host: 'localhost' })); uses default export but misses const assignment. registerAs('database', { host: 'localhost' }); passes object directly, not a function. registerAs('database', () => { host: 'localhost' }); misses returning an object (no parentheses).

3. Final Answer:

   export const database = registerAs('database', () => ({ host: 'localhost' })); -> Option A

4. Quick Check:

   Correct syntax = A [OK]

Hint: Use export const with registerAs and a function returning config [OK]

Common Mistakes:

• Passing object directly instead of function
• Missing export const declaration
• Not returning an object from the function

3. Given the following configuration namespace registered as 'app':

export const appConfig = registerAs('app', () => ({ port: 3000, env: 'dev' }));

What will configService.get('app.port') return?

medium

A. 3000

B. 'app.port'

C. undefined

D. An error is thrown

Solution

1. Step 1: Understand dot notation access in ConfigService

   Using configService.get('app.port') accesses the 'port' key inside the 'app' namespace.

2. Step 2: Check the registered config values

   The 'app' namespace returns an object with port: 3000, so the call returns 3000.

3. Final Answer:

   3000 -> Option A

4. Quick Check:

   configService.get('namespace.key') returns value = B [OK]

Hint: Use dot notation to get nested config values [OK]

Common Mistakes:

• Expecting the string 'app.port' as output
• Assuming undefined if namespace not accessed properly
• Thinking it throws an error for valid keys

4. Consider this code snippet:

export const apiConfig = registerAs('api', () => ({ url: 'https://api.example.com' }));

// Later in service
const url = configService.get('api.url');

What is the likely cause if url is undefined?

medium

A. The configService instance is not injected properly

B. The namespace 'api' was not imported or registered in ConfigModule

C. Dot notation is not supported in configService.get()

D. The key 'url' does not exist in the 'api' namespace

Solution

1. Step 1: Check registration of namespace

   If the 'api' namespace is not imported or registered in the ConfigModule, its keys won't be available.

2. Step 2: Verify key existence and usage

   The key 'url' exists in the namespace, and dot notation is supported, so these are not issues.

3. Step 3: Consider injection issues

   While injection problems can cause errors, they usually throw exceptions, not silently return undefined.

4. Final Answer:

   The namespace 'api' was not imported or registered in ConfigModule -> Option B

5. Quick Check:

   Missing namespace registration = D [OK]

Hint: Always import and register namespaces in ConfigModule [OK]

Common Mistakes:

• Assuming dot notation is unsupported
• Thinking missing key causes error instead of undefined
• Ignoring namespace registration step

5. You have two configuration namespaces registered:

export const dbConfig = registerAs('database', () => ({ host: 'localhost', port: 5432 }));
export const authConfig = registerAs('auth', () => ({ jwtSecret: 'secret' }));

How can you access the JWT secret inside a service using ConfigService and ensure type safety?

hard

A. const secret = configService.get<number>('auth.jwtSecret');

B. const secret = configService.get('jwtSecret');

C. const secret = configService.get<string>('auth.jwtSecret');

D. const secret = configService.get('database.jwtSecret');

Solution

1. Step 1: Use dot notation with namespace and key

   To access the JWT secret, use 'auth.jwtSecret' to specify the namespace and key.

2. Step 2: Apply type safety with generic parameter

   Pass <string> to get to ensure the returned value is typed as string.

3. Step 3: Eliminate incorrect options

   const secret = configService.get('jwtSecret'); misses namespace, A uses wrong type, D uses wrong namespace.

4. Final Answer:

   const secret = configService.get<string>('auth.jwtSecret'); -> Option C

5. Quick Check:

   Use namespace.key with type param = C [OK]

Hint: Use configService.get<Type>('namespace.key') for typed access [OK]

Common Mistakes:

• Omitting namespace in key string
• Using wrong type parameter
• Accessing key from wrong namespace