@types/config 3.3.5 → 4.4.0

config/README.md

@@ -1,15 +1,3 @@
-# Installation
-> `npm install --save @types/config`
-
-# Summary
-This package contains type definitions for config (https://github.com/lorenwest/node-config).
-
-# Details
-Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/config.
-
-### Additional Details
- * 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), [Christian Vaagland Tellnes](https://github.com/tellnes), and [Paritosh Bhatia](https://github.com/ParitoshBh).
+This is a stub types definition for @types/config (http://github.com/node-config/node-config.git).
+
+config provides its own type definitions, so you don't need @types/config installed!

config/package.json

@@ -1,50 +1,12 @@
 {
     "name": "@types/config",
-    "version": "3.3.5",
-    "description": "TypeScript definitions for config",
-    "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/config",
-    "license": "MIT",
-    "contributors": [
-        {
-            "name": "Roman Korneev",
-            "githubUsername": "RWander",
-            "url": "https://github.com/RWander"
-        },
-        {
-            "name": "Forrest Bice",
-            "githubUsername": "forrestbice",
-            "url": "https://github.com/forrestbice"
-        },
-        {
-            "name": "James Donald",
-            "githubUsername": "jndonald3",
-            "url": "https://github.com/jndonald3"
-        },
-        {
-            "name": "Alberto Vasquez",
-            "githubUsername": "albertovasquez",
-            "url": "https://github.com/albertovasquez"
-        },
-        {
-            "name": "Christian Vaagland Tellnes",
-            "githubUsername": "tellnes",
-            "url": "https://github.com/tellnes"
-        },
-        {
-            "name": "Paritosh Bhatia",
-            "githubUsername": "ParitoshBh",
-            "url": "https://github.com/ParitoshBh"
-        }
-    ],
+    "version": "4.4.0",
+    "description": "Stub TypeScript definitions entry for config, which provides its own types definitions",
     "main": "",
-    "types": "index.d.ts",
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git",
-        "directory": "types/config"
-    },
     "scripts": {},
-    "dependencies": {},
-    "typesPublisherContentHash": "6b0a351b5b0630d58f027161bcf83523c39ecda3d5c25865e3fd51d5ae3b1789",
-    "typeScriptVersion": "4.8"
+    "license": "MIT",
+    "dependencies": {
+        "config": "*"
+    },
+    "deprecated": "This is a stub types definition. config provides its own type definitions, so you do not need this installed."
 }

config/async.d.ts

@@ -1,7 +0,0 @@
-import { IConfig } from "./";
-
-type AsyncFunction<T, R> = (this: IConfig, config: string, origValue: T) => Promise<R>;
-
-export function asyncConfig<R>(promise: Promise<any>): Promise<R>;
-export function asyncConfig<T, R>(func: AsyncFunction<T, R>): Promise<R>;
-export function resolveAsyncConfigs(config: IConfig): Promise<IConfig>;

config/defer.d.ts

@@ -1,8 +0,0 @@
-type DeferFunction<T, R> = (this: any, origValue: T) => R;
-
-/*
- * Allows a config value to be deferred for later. The original config object is passed
- * into func as "this".
- * See: https://github.com/lorenwest/node-config/wiki/Special-features-for-JavaScript-configuration-files#deferred-values-in-javascript-configuration-files
- */
-export function deferConfig<T, R>(func: DeferFunction<T, R>): R;

config/index.d.ts

@@ -1,89 +0,0 @@
-import { ConfigPaths, ConfigPathValues, HasBeenAugmented } from "./utils";
-
-declare var c: c.IConfig;
-
-declare namespace c {
-    // see https://github.com/lorenwest/node-config/wiki/Using-Config-Utilities
-    interface IUtil {
-        // Extend an object (and any object it contains) with one or more objects (and objects contained in them).
-        extendDeep(mergeInto: any, mergeFrom: any, depth?: number): any;
-        extendDeep(mergeInto: any, mergeFrom1: any, mergeFrom2: any, depth?: number): any;
-        extendDeep(mergeInto: any, ...mergeFrom: any): any;
-
-        // 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;
-
-        // Returns an object containing all elements that differ between two objects.
-        diffDeep(object1: any, object2: any, depth?: number): any;
-
-        // Make a javascript object property immutable (assuring it cannot be changed from the current value).
-        makeImmutable(object: any, propertyName?: string, propertyValue?: string): any;
-
-        // Make an object property hidden so it doesn't appear when enumerating elements of the object.
-        makeHidden(object: any, propertyName: string, propertyValue?: string): any;
-
-        // Get the current value of a config environment variable
-        getEnv(varName: string): string;
-
-        // Return the config for the project based on directory param if not directory then return default one (config).
-        loadFileConfigs(configDir?: string): any;
-
-        // Return the sources for the configurations
-        getConfigSources(): IConfigSource[];
-
-        // Returns a new deep copy of the current config object, or any part of the config if provided.
-        toObject(config?: any): any;
-
-        /**
-         * This allows module developers to attach their configurations onto the default configuration object
-         * so they can be configured by the consumers of the module.
-         */
-        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: 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;
-    }
-
-    interface IConfigSource {
-        name: string;
-        original?: string | undefined;
-        parsed: any;
-    }
-}
-
-export = c;

config/raw.d.ts

@@ -1,10 +0,0 @@
-/* The raw function returns an object as-is instead of passing it through processes that will make the object immutable.
- * See: https://github.com/lorenwest/node-config/wiki/Special-features-for-JavaScript-configuration-files#using-promises-processstdout-and-other-objects-in-javascript-config-files
- */
-
-export class RawConfig<T> {
-    constructor(rawObj: T);
-    resolve(): T;
-}
-
-export function raw<T>(obj: T): RawConfig<T>;

config/utils.d.ts

@@ -1,20 +0,0 @@
-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;