Custom configuration files in NestJS - Step-by-Step Execution

Concept Flow - Custom configuration files

Create config file

↓

Export config object

↓

Import config in module

↓

Use ConfigModule.forRoot({ load: [customConfig

↓

Inject ConfigService

↓

Access config values with get()

↓

Use config values in app

This flow shows how to create a custom config file, load it with ConfigModule, inject ConfigService, and access config values.

Execution Sample

NestJS

export default () => ({
  port: 3000,
  database: { host: 'localhost', port: 5432 },
});

Defines a custom configuration object with port and database settings.

Execution Table

Step	Action	Input/Code	Result/State
1	Create config file	export default () => ({ port: 3000, database: { host: 'localhost', port: 5432 } })	Config function ready to export
2	Import config in app module	import customConfig from './custom.config'	customConfig function available
3	Load config with ConfigModule	ConfigModule.forRoot({ load: [customConfig] })	ConfigModule loads customConfig into ConfigService
4	Inject ConfigService in service	constructor(private configService: ConfigService) {}	ConfigService instance ready
5	Access config value	this.configService.get('port')	Returns 3000
6	Access nested config	this.configService.get('database.host')	Returns 'localhost'
7	Use config value	app.listen(port)	App listens on port 3000
8	Exit	N/A	App running with custom config loaded

💡 App starts listening after loading custom configuration values

Variable Tracker

Variable	Start	After Step 1	After Step 3	After Step 5	Final
customConfig	undefined	Function returning config object	Loaded into ConfigService	N/A	N/A
configService	undefined	undefined	Instance created	Has config values	Used to get config
port	undefined	undefined	undefined	3000	3000

Key Moments - 3 Insights

Why do we export a function instead of a plain object in the config file?

Exporting a function allows the config to be dynamic and evaluated when loaded, as shown in step 1 and 3 of the execution_table.

How do we access nested configuration values like database host?

Use dot notation in get(), e.g., get('database.host'), as shown in step 6 of the execution_table.

What happens if we forget to load the custom config in ConfigModule?

ConfigService won't have the custom values, so get() returns undefined or defaults, shown by the importance of step 3.

Visual Quiz - 3 Questions

Look at the execution_table, what does this.configService.get('port') return at step 5?

A undefined

B 3000

C Error

D null

💡 Hint

Check step 5 in execution_table where get('port') returns 3000

At which step is the customConfig function loaded into ConfigService?

A Step 2

B Step 4

C Step 3

D Step 5

💡 Hint

Look at step 3 in execution_table where ConfigModule.forRoot loads customConfig

If we change the port in customConfig to 4000, what changes in variable_tracker?

A port changes to 4000 after step 5

B customConfig becomes undefined

C configService is undefined

D No change in port value

💡 Hint

Variable 'port' value after step 5 reflects the configService.get('port') result

Concept Snapshot

Custom config files in NestJS:
- Export a function returning config object
- Load with ConfigModule.forRoot({ load: [customConfig] })
- Inject ConfigService to access values
- Use get('key') or get('nested.key')
- Enables dynamic, organized app settings

Full Transcript

In NestJS, custom configuration files are created by exporting a function that returns an object with settings like port and database details. This function is imported and loaded into the ConfigModule using the load option. The ConfigService is then injected into services or controllers to access these config values using the get method. Nested values can be accessed with dot notation. This approach allows dynamic and centralized configuration management for the app. The execution steps show creating the config, loading it, injecting the service, and accessing values to start the app on the configured port.