Install

Yarn

yarn add nestjs-env

NPM

npm install nestjs-env --save

This library is not responsible for loading environment variables from a file, for this you need to use env-cmd or dotenv.

Getting Started

Let's imagine that we have a folder called src/config in our project that contains several configuration files.

/src
├── app.module.ts
├── app.service.ts
├── config
│   ├── app.config.ts
│   └── index.ts
bootstrap.ts

Example app.config.ts

import { Env } from 'nestjs-env';

export class AppConfig {
  @Env('PORT', { default: 3000 })
  port: number;

  @Env('NODE_ENV')
  env: string;

  get isDevelopment() {
    return this.env === 'development';
  }
}

Let's register the config module in app.module.ts

import { Module } from '@nestjs/common';
import { EnvModule } from 'nestjs-env';
import { AppConfig } from 'src/config';

@Module({
  imports: [EnvModule.register([AppConfig])],
})
export class AppModule {}

Usage

Now we are ready to inject our AppConfig anywhere we'd like.

import { AppConfig } from 'src/config';

@Injectable()
class AppService {
  constructor(private readonly appConfig: AppConfig) {
    console.log(this.appConfig.isDevelopment);
  }
}

import { AppConfig } from 'src/config';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  const config = app.get(AppConfig);

  await app.listen(config.port);
}

That's it!

CLI

The nestjs-env CLI is a command-line interface tool that helps you to build env example file.

$ nestjs-env generate

| Options | Alias | Description | Default | |-------------|-------|--------------------------------------------------------------|--------------| | --filename | -f | Name of the file to which the example will be written. | .env.example | | --pattern | -p | Template string specifying the names of files with configs | .config.ts | | --ignore | -i | Specify directory that should be excluded | node_modules | | --directory | -d | Specifies the base directory from which file scanning begins | src/ | | --output | -o | Specify an output folder for generated file | | | --print | | Prints an output to the console | false |

License

The MIT License (MIT)