feat: createDefineConfig and DefineConfig

unjs · Mar 14, 2023 · 40a921e · 40a921e
1 parent 538915e
commit 40a921e
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 4 deletions.
diff --git a/src/types.ts b/src/types.ts
@@ -94,3 +94,15 @@ export interface LoadConfigOptions<
         extendKey?: string | string[];
       };
 }
+
+export type DefineConfig<
+  T extends UserInputConfig = UserInputConfig,
+  MT extends ConfigLayerMeta = ConfigLayerMeta
+> = (input: InputConfig<T, MT>) => InputConfig<T, MT>;
+
+export function createDefineConfig<
+  T extends UserInputConfig = UserInputConfig,
+  MT extends ConfigLayerMeta = ConfigLayerMeta
+>(): DefineConfig<T, MT> {
+  return (input: InputConfig<T, MT>) => input;
+}
diff --git a/test/types.ts b/test/types.ts
@@ -1,5 +1,5 @@
 import { expectTypeOf } from "expect-type";
-import { loadConfig, InputConfig } from "../src";
+import { loadConfig, InputConfig, createDefineConfig } from "../src";
 
 interface MyConfig {
   foo: string;
@@ -9,17 +9,17 @@ interface MyMeta {
   metaFoo: string;
 }
 
-type UserConfig = InputConfig<MyConfig, MyMeta>;
+const defineMyConfig = createDefineConfig<MyConfig, MyMeta>();
 
-const userConfig: UserConfig = {
+const userConfig = defineMyConfig({
   foo: "bar",
   $meta: {
     metaFoo: "bar",
   },
   $development: {
     foo: "bar",
   },
-};
+});
 
 expectTypeOf(userConfig.$production!.foo).toEqualTypeOf<string>();
 expectTypeOf(userConfig.$meta!.metaFoo).toEqualTypeOf<string>();