ConfigModule
Loads environment variables and configuration into the DI container.
Syntax
ConfigModule.forRoot(options?: ConfigModuleOptions) Parameters
| Name | Type | Required | Description |
|---|---|---|---|
options | ConfigModuleOptions | No | Settings like isGlobal, envFilePath, load, cache, and validationSchema. |
Returns
DynamicModule — A configured module exporting ConfigService.
Examples
import { Module } from '@nestjs/common';
import { ConfigModule } from '@nestjs/config';
@Module({
imports: [
ConfigModule.forRoot({
isGlobal: true,
envFilePath: '.env',
cache: true,
}),
],
})
export class AppModule {}
Notes
Install @nestjs/config. Set `isGlobal: true` to avoid re-importing in
every module. Use `load` for typed config factories and
`validationSchema` (Joi) to fail fast on missing variables.