@nestjs/config

What is @nestjs/config?

The @nestjs/config package is a configuration solution for NestJS applications. It allows developers to load and use configuration variables in a structured and scalable way. The package supports loading configuration from environment variables and custom configuration files, making it easier to manage application settings across different environments.

What are @nestjs/config's main functionalities?

Environment Variables Loading

This feature allows the application to load configuration variables from environment variables. The `forRoot` method can be used to customize the behavior, such as specifying a custom env file path.

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

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

Custom Configuration Files

This feature enables the application to load configuration settings from custom files. Developers can define a configuration file that exports a configuration object and load it using the `load` option.

import { ConfigModule } from '@nestjs/config';
import configuration from './config/configuration';

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

Typed Configuration

This feature allows accessing configuration variables with type safety. The `ConfigService`'s `get` method can be used to retrieve configuration variables, optionally specifying the expected type.

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

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

  someMethod() {
    const dbUser = this.configService.get<string>('DATABASE_USER');
  }
}

Other packages similar to @nestjs/config

dotenv

dotenv is a popular package for loading environment variables from a `.env` file into `process.env`. Unlike @nestjs/config, dotenv does not provide built-in support for NestJS modules or services, making it less integrated for NestJS applications but more versatile for other Node.js projects.

config

The `config` package allows managing configuration files in Node.js applications. It supports loading configurations from files based on the deployment environment. While it offers a structured approach to configuration management, it lacks the deep integration and features specifically designed for NestJS applications provided by @nestjs/config.

convict

convict extends the basic configuration management by adding schema definitions, environment variables support, and validation. It's more comparable to @nestjs/config in terms of functionality but is not tailored specifically for NestJS, requiring more setup for use in NestJS applications.

README

A progressive Node.js framework for building efficient and scalable server-side applications.

Description

Configuration module for Nest based on the dotenv (to load process environment variables) package.

Installation

$ npm i --save @nestjs/config

Quick Start

Overview & Tutorial

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

• Author - Kamil Myśliwiec
• Website - https://nestjs.com
• Twitter - @nestframework

License

Nest is MIT licensed.