@cubiles/nestjs-config-utils v11.0.1

Description

This is extended from the official Config-Module of NestJs. The main function of the packages is a typesafe validation(class-validator) of the env.

Installation

$ npm i @cubiles/nest-config-utils @nestjs/config class-validator class-transformer

YAML Support

$ npm i js-yaml path
$ npm i -D @types/js-yaml

Features

• Extends NestJs-Config Module
• Native default values of class
• Usage class-validator
• Support of YAML
• Simple usages

Example

// App.config.ts
import { FromEnv } from '@cubiles/nestjs-config-utils';
import { IsString, IsNumber } from 'class-validator';

export class AppConfig {
  @FromEnv('APP_ADDRESS')
  @IsString()
  readonly address: string = 'localhost';

  @FromEnv('APP_PORT')
  @IsNumber()
  readonly port: number = 1234;
}

// Yaml.config.ts
import { IsArray, IsNumber, IsString } from 'class-validator';

export class YamlConfig {

  @IsArray()
  @IsString({each: true})
  readonly address: string[] = [];

  @IsNumber()
  readonly port: number = (() => 6666)();
}

// App.service.ts
import { Injectable, OnModuleInit } from '@nestjs/common';
import { InjectConfig } from '@cubiles/nestjs-config-utils';
import { AppConfig } from './App.config';
import { YamlConfig } from './YAML.config';

@Injectable()
export class AppService implements OnModuleInit {

  constructor(
    @InjectConfig(AppConfig) private readonly config: AppConfig,
    @InjectConfig(YamlConfig) private readonly yamlConfig: YamlConfig,
  ) {
  }

  onModuleInit(): any {
    console.log(this.config);
    console.log(this.yamlConfig);
  }
}

// Config.module.ts
import { Module } from "@nestjs/common";
import { AppConfig } from "./App.config";
import { YamlConfig } from "./YAML.config";
import { AppService } from "./App.service";
import { TypedConfig, TypedYamlConfig } from "@cubiles/nestjs-config-utils";

@Module({
  imports: [
    ConfigModule.forRoot(),
    TypedConfig.forFeature(AppConfig),
    TypedYamlConfig.forFeature(YamlConfig, "./test/app/example.yml")
  ],
  controllers: [],
  providers: [AppService]
})
export class AppModule {
}

// main.ts
async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  
  const appConfig: AppConfig = app.get(getConfigToken(AppConfig.name));
  
  await app.listen(appConfig.port, appConfig.address);
}

bootstrap();