fix: improve typing for forRoot and forRootAsync

Nikaple · May 17, 2021 · 32acbbb · 32acbbb
1 parent 881571d
commit 32acbbb
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 11 deletions.
diff --git a/lib/interfaces/typed-config-module-options.interface.ts b/lib/interfaces/typed-config-module-options.interface.ts
@@ -1,9 +1,8 @@
 import { ClassConstructor } from 'class-transformer';
 import { ValidatorOptions } from 'class-validator';
 
-export type ConfigLoader = () =>
-  | Promise<Record<string, any>>
-  | Record<string, any>;
+export type ConfigLoader = () => Record<string, any>;
+export type AsyncConfigLoader = () => Promise<Record<string, any>>;
 
 export interface TypedConfigModuleOptions {
   /**
@@ -12,7 +11,7 @@ export interface TypedConfigModuleOptions {
   schema: ClassConstructor<any>;
 
   /**
-   * Function to load configurations, can be sync or async.
+   * Function(s) to load configurations, must be synchronous.
    */
   load: ConfigLoader | ConfigLoader[];
 
@@ -46,3 +45,11 @@ export interface TypedConfigModuleOptions {
    */
   validationOptions?: ValidatorOptions;
 }
+
+export interface TypedConfigModuleAsyncOptions
+  extends TypedConfigModuleOptions {
+  /**
+   * Function(s) to load configurations, can be synchronous or asynchronous.
+   */
+  load: AsyncConfigLoader | AsyncConfigLoader[];
+}
diff --git a/lib/typed-config.module.ts b/lib/typed-config.module.ts
@@ -8,7 +8,7 @@ import {
 } from 'class-validator';
 import merge from 'lodash.merge';
 import {
-  ConfigLoader,
+  TypedConfigModuleAsyncOptions,
   TypedConfigModuleOptions,
 } from './interfaces/typed-config-module-options.interface';
 import { forEachDeep } from './utils/for-each-deep.util';
@@ -17,22 +17,22 @@ import { debug } from './utils/debug.util';
 
 @Module({})
 export class TypedConfigModule {
-  static forRoot(options: TypedConfigModuleOptions): DynamicModule {
+  public static forRoot(options: TypedConfigModuleOptions): DynamicModule {
     const rawConfig = this.getRawConfig(options.load);
 
     return this.getDynamicModule(options, rawConfig);
   }
 
-  static async forRootAsync(
-    options: TypedConfigModuleOptions,
+  public static async forRootAsync(
+    options: TypedConfigModuleAsyncOptions,
   ): Promise<DynamicModule> {
     const rawConfig = await this.getRawConfigAsync(options.load);
 
     return this.getDynamicModule(options, rawConfig);
   }
 
   private static getDynamicModule(
-    options: TypedConfigModuleOptions,
+    options: TypedConfigModuleOptions | TypedConfigModuleAsyncOptions,
     rawConfig: Record<string, any>,
   ) {
     const {
@@ -60,7 +60,7 @@ export class TypedConfigModule {
     };
   }
 
-  private static getRawConfig(load: ConfigLoader | ConfigLoader[]) {
+  private static getRawConfig(load: TypedConfigModuleOptions['load']) {
     if (Array.isArray(load)) {
       const config = {};
       for (const fn of load) {
@@ -76,7 +76,9 @@ export class TypedConfigModule {
     return load();
   }
 
-  private static async getRawConfigAsync(load: ConfigLoader | ConfigLoader[]) {
+  private static async getRawConfigAsync(
+    load: TypedConfigModuleAsyncOptions['load'],
+  ) {
     if (Array.isArray(load)) {
       const config = {};
       for (const fn of load) {