@types/config 3.3.3 → 3.3.5

config/README.md

@@ -8,8 +8,8 @@ This package contains type definitions for config (https://github.com/lorenwest/
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/config.
 
 ### Additional Details
- * Last updated: Mon, 06 Nov 2023 22:41:05 GMT
+ * Last updated: Tue, 03 Sep 2024 23:36:04 GMT
  * Dependencies: none
 
 # Credits
-These definitions were written by [Roman Korneev](https://github.com/RWander), [Forrest Bice](https://github.com/forrestbice), [James Donald](https://github.com/jndonald3), [Alberto Vasquez](https://github.com/albertovasquez), and [Christian Vaagland Tellnes](https://github.com/tellnes).
+These definitions were written by [Roman Korneev](https://github.com/RWander), [Forrest Bice](https://github.com/forrestbice), [James Donald](https://github.com/jndonald3), [Alberto Vasquez](https://github.com/albertovasquez), [Christian Vaagland Tellnes](https://github.com/tellnes), and [Paritosh Bhatia](https://github.com/ParitoshBh).

config/index.d.ts

@@ -1,3 +1,5 @@
+import { ConfigPaths, ConfigPathValues, HasBeenAugmented } from "./utils";
+
 declare var c: c.IConfig;
 
 declare namespace c {
@@ -11,6 +13,9 @@ declare namespace c {
         // Return a deep copy of the specified object.
         cloneDeep(copyFrom: any, depth?: number): any;
 
+        // Set objects given a path as a string list
+        setPath(object: object, path: string[], value?: any): void;
+
         // Return true if two objects have equal contents.
         equalsDeep(object1: any, object2: any, dept?: number): boolean;
 
@@ -42,8 +47,34 @@ declare namespace c {
         setModuleDefaults(moduleName: string, defaults: any): any;
     }
 
+    /**
+     * By augmenting this interface with your own config, you can greatly improve the IntelliSense for the `get` method:
+     * - Dot notation paths for the `setting` parameter
+     * - Correctly typed return values
+     *
+     * @example
+     * declare module 'config' {
+     *   interface IConfig extends MyConfig {}
+     * }
+     *
+     * @example
+     * declare module 'config' {
+     *   interface IConfig {
+     *     myConfig: {
+     *       myString: string;
+     *       myNumber: number;
+     *     };
+     *   }
+     * }
+     *
+     * @example
+     * const knownToBeStringTyped = config.get('myConfig.myString');
+     */
     interface IConfig {
-        get<T>(setting: string): T;
+        get: HasBeenAugmented<IConfig> extends true
+            ? <T extends ConfigPaths<IConfig>>(setting: T) => ConfigPathValues<IConfig, T>
+            : <T>(setting: string) => T;
+        has(setting: ConfigPaths<IConfig>): boolean;
         has(setting: string): boolean;
         util: IUtil;
     }

config/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/config",
-    "version": "3.3.3",
+    "version": "3.3.5",
     "description": "TypeScript definitions for config",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/config",
     "license": "MIT",
@@ -29,6 +29,11 @@
             "name": "Christian Vaagland Tellnes",
             "githubUsername": "tellnes",
             "url": "https://github.com/tellnes"
+        },
+        {
+            "name": "Paritosh Bhatia",
+            "githubUsername": "ParitoshBh",
+            "url": "https://github.com/ParitoshBh"
         }
     ],
     "main": "",
@@ -40,6 +45,6 @@
     },
     "scripts": {},
     "dependencies": {},
-    "typesPublisherContentHash": "6209b0a13db5f48492293400c4c02c56d7f7a27060887c348741fd6ecc3032b1",
-    "typeScriptVersion": "4.5"
+    "typesPublisherContentHash": "6b0a351b5b0630d58f027161bcf83523c39ecda3d5c25865e3fd51d5ae3b1789",
+    "typeScriptVersion": "4.8"
 }

config/utils.d.ts

@@ -0,0 +1,20 @@
+type Join<K, P> = K extends string | number ? P extends string | number ? `${K}${"" extends P ? "" : "."}${P}`
+    : never
+    : never;
+
+export type ConfigPaths<T> = T extends object ? {
+        [K in keyof T]-?: K extends string | number ? `${K}` | Join<K, ConfigPaths<T[K]>>
+            : never;
+    }[keyof T]
+    : "";
+
+export type ConfigPathValues<O, P extends string> = P extends `${infer K}.${infer Rest}`
+    ? K extends keyof O ? ConfigPathValues<O[K], Rest>
+    : never
+    : P extends keyof O ? O[P]
+    : never;
+
+type IsSubsetOf<T, U> = T extends U ? true : false;
+
+export type HasBeenAugmented<T> = IsSubsetOf<Exclude<keyof T, "get" | "has" | "util">, never> extends true ? false
+    : true;