chore: add preload example

examples/basic/package.json

@@ -1,12 +1,14 @@
 {
-    "name": "nest-typed-config-examples",
+    "name": "nest-typed-config-example-basic",
     "version": "1.0.0",
     "description": "",
     "main": "index.js",
     "dependencies": {
         "nest-typed-config": "latest"
     },
-    "devDependencies": {},
+    "devDependencies": {
+        "@nestjs/cli": "^7.6.0"
+    },
     "scripts": {
         "start": "nest start --watch",
         "test": "echo \"Error: no test specified\" && exit 1"

examples/preload/.env.json

@@ -0,0 +1,7 @@
+{
+    "host": "127.0.0.1",
+    "port": 26874,
+    "route": {
+        "app": "/app"
+    }
+}

examples/preload/README.md

@@ -0,0 +1,3 @@
+# Basic Example
+
+This folder is an example project to demonstrate `Nest-Typed-Config`

examples/preload/nest-cli.json

@@ -0,0 +1,4 @@
+{
+    "collection": "@nestjs/schematics",
+    "sourceRoot": "src"
+}

examples/preload/package.json

@@ -0,0 +1,19 @@
+{
+    "name": "nest-typed-config-example-preload",
+    "version": "1.0.0",
+    "description": "",
+    "main": "index.js",
+    "dependencies": {
+        "nest-typed-config": "latest"
+    },
+    "devDependencies": {
+        "@nestjs/cli": "^7.6.0"
+    },
+    "scripts": {
+        "start": "nest start --watch",
+        "test": "echo \"Error: no test specified\" && exit 1"
+    },
+    "keywords": [],
+    "author": "",
+    "license": "ISC"
+}

examples/preload/src/app.controller.ts

@@ -0,0 +1,13 @@
+import { Controller, Get } from '@nestjs/common';
+import { AppService } from './app.service';
+import { rootConfig } from './config.module';
+
+@Controller(rootConfig.route.app)
+export class AppController {
+  constructor(private readonly appService: AppService) {}
+
+  @Get()
+  show(): void {
+    return this.appService.show();
+  }
+}

examples/preload/src/app.module.ts

@@ -0,0 +1,11 @@
+import { Module } from '@nestjs/common';
+import { AppController } from './app.controller';
+import { AppService } from './app.service';
+import { ConfigModule } from './config.module';
+
+@Module({
+  imports: [ConfigModule],
+  providers: [AppService],
+  controllers: [AppController],
+})
+export class AppModule {}

examples/preload/src/app.service.ts

@@ -0,0 +1,13 @@
+import { Injectable } from '@nestjs/common';
+import { RootConfig } from './config';
+
+@Injectable()
+export class AppService {
+  // inject any config or sub-config you like
+  constructor(private config: RootConfig) {}
+
+  // enjoy type safety!
+  public show(): any {
+    return `Your configuration is: \n${JSON.stringify(this.config, null, 4)}\n`;
+  }
+}

examples/preload/src/config.module.ts

@@ -0,0 +1,9 @@
+import { TypedConfigModule, fileLoader, selectConfig } from 'nest-typed-config';
+import { RootConfig } from './config';
+
+export const ConfigModule = TypedConfigModule.forRoot({
+  schema: RootConfig,
+  load: fileLoader(),
+});
+
+export const rootConfig = selectConfig(ConfigModule, RootConfig);

examples/preload/src/config.ts

@@ -0,0 +1,19 @@
+import { Type } from 'class-transformer';
+import { IsDefined, IsNumber, IsString } from 'class-validator';
+
+export class RouteConfig {
+  @IsString()
+  public readonly app!: string;
+}
+
+export class RootConfig {
+  @IsString()
+  public readonly host!: string;
+
+  @IsNumber()
+  public readonly port!: number;
+
+  @IsDefined()
+  @Type(() => RouteConfig)
+  public readonly route!: RouteConfig;
+}

examples/preload/src/main.ts

@@ -0,0 +1,18 @@
+import { NestFactory } from '@nestjs/core';
+import { AppModule } from './app.module';
+import { RootConfig } from './config';
+
+async function bootstrap() {
+  const app = await NestFactory.create(AppModule);
+  const { host, port, route } = app.get(RootConfig);
+
+  await app.listen(port, host);
+
+  console.log(
+    `\nApp successfully bootstrapped. You can try running:
+    
+    curl http://${host}:${port}${route.app}`,
+  );
+}
+
+bootstrap().catch(console.error);

examples/preload/tsconfig.build.json

@@ -0,0 +1,6 @@
+{
+    "extends": "./tsconfig.json",
+    "compilerOptions": {
+        "outDir": "./dist",
+    }
+}

examples/preload/tsconfig.json

@@ -0,0 +1,13 @@
+{
+    "extends": "../../tsconfig.json",
+    "compilerOptions": {
+        "rootDir": "src"
+    },
+    "include": [
+        "src/**/*"
+    ],
+    "exclude": [
+        "node_modules",
+        "dist"
+    ]
+}