config 4.2.1 → 4.4.0

package/LICENSE

@@ -1,4 +1,4 @@
-// Copyright 2010-2025, Loren West and other contributors
+// Copyright 2010-2026, Loren West and other contributors
 
 // Permission is hereby granted, free of charge, to any person obtaining a copy
 // of this software and associated documentation files (the "Software"), to

package/README.md

@@ -1,9 +1,11 @@
 Configure your Node.js Applications
 ===================================
 
-[![NPM](https://nodei.co/npm/config.svg?downloads=true&downloadRank=true)](https://nodei.co/npm/config/)  
-[![Build Status](https://secure.travis-ci.org/node-config/node-config.svg?branch=master)](https://travis-ci.org/lorenwest/node-config)  
-[release notes](https://github.com/node-config/node-config/blob/master/History.md)
+[![npm package](https://img.shields.io/npm/v/config)](https://www.npmjs.com/package/config)
+[![Downloads](https://img.shields.io/npm/dt/config)](https://www.npmjs.com/package/config)
+[![Issues](https://img.shields.io/github/issues/node-config/node-config)](https://github.com/node-config/node-config/issues)
+
+[Release Notes](https://github.com/node-config/node-config/releases)
 
 Introduction
 ------------
@@ -105,6 +107,11 @@ Running in this configuration, the `port` and `dbName` elements of `dbConfig`
 will come from the `default.json` file, and the `host` element will
 come from the `production.json` override file.
 
+TypeScript
+----------
+
+Type declarations are published under `types/` and resolved via `typesVersions`. Subpath typings are included for `config/async`, `config/defer`, `config/parser`, `config/raw`, and `config/lib/util` in addition to the main `config` entrypoint.
+
 Articles
 --------
 
@@ -135,35 +142,35 @@ If you still don't see what you are looking for, here are some more resources to
 Contributors
 ------------
 <table id="contributors"><tr><td><img src=https://avatars.githubusercontent.com/u/373538?v=4><a href="https://github.com/lorenwest">lorenwest</a></td>
-<td><img src=https://avatars.githubusercontent.com/u/25829?v=4><a href="https://github.com/markstos">markstos</a></td>
 <td><img src=https://avatars.githubusercontent.com/u/1656505?v=4><a href="https://github.com/jdmarshall">jdmarshall</a></td>
+<td><img src=https://avatars.githubusercontent.com/u/25829?v=4><a href="https://github.com/markstos">markstos</a></td>
 <td><img src=https://avatars.githubusercontent.com/u/1083065?v=4><a href="https://github.com/iMoses">i&shy;Moses</a></td>
 <td><img src=https://avatars.githubusercontent.com/u/447151?v=4><a href="https://github.com/elliotttf">elliotttf</a></td>
-<td><img src=https://avatars.githubusercontent.com/u/8839447?v=4><a href="https://github.com/jfelege">jfelege</a></td>
-</tr><tr><td><img src=https://avatars.githubusercontent.com/u/66902?v=4><a href="https://github.com/leachiM2k">leachi&shy;M2k</a></td>
-<td><img src=https://avatars.githubusercontent.com/u/133277?v=4><a href="https://github.com/enyo">enyo</a></td>
+<td><img src=https://avatars.githubusercontent.com/u/11448209?v=4><a href="https://github.com/mdkitzman">mdkitzman</a></td>
+</tr><tr><td><img src=https://avatars.githubusercontent.com/u/8839447?v=4><a href="https://github.com/jfelege">jfelege</a></td>
+<td><img src=https://avatars.githubusercontent.com/u/66902?v=4><a href="https://github.com/leachiM2k">leachi&shy;M2k</a></td>
 <td><img src=https://avatars.githubusercontent.com/u/791137?v=4><a href="https://github.com/josx">josx</a></td>
+<td><img src=https://avatars.githubusercontent.com/u/133277?v=4><a href="https://github.com/enyo">enyo</a></td>
 <td><img src=https://avatars.githubusercontent.com/u/4307697?v=4><a href="https://github.com/leosuncin">leosuncin</a></td>
 <td><img src=https://avatars.githubusercontent.com/u/1077378?v=4><a href="https://github.com/arthanzel">arthanzel</a></td>
-<td><img src=https://avatars.githubusercontent.com/u/8650543?v=4><a href="https://github.com/leonardovillela">leonardovillela</a></td>
-</tr><tr><td><img src=https://avatars.githubusercontent.com/u/77355440?v=4><a href="https://github.com/jeremy-daley-kr">jeremy-daley-kr</a></td>
+</tr><tr><td><img src=https://avatars.githubusercontent.com/u/8650543?v=4><a href="https://github.com/leonardovillela">leonardovillela</a></td>
+<td><img src=https://avatars.githubusercontent.com/u/77355440?v=4><a href="https://github.com/jeremy-daley-kr">jeremy-daley-kr</a></td>
 <td><img src=https://avatars.githubusercontent.com/u/2529835?v=4><a href="https://github.com/simon-scherzinger">simon-scherzinger</a></td>
 <td><img src=https://avatars.githubusercontent.com/u/5138570?v=4><a href="https://github.com/BadgerBadgerBadgerBadger">Badger&shy;Badger&shy;Badger&shy;Badger</a></td>
 <td><img src=https://avatars.githubusercontent.com/u/842998?v=4><a href="https://github.com/nsabovic">nsabovic</a></td>
 <td><img src=https://avatars.githubusercontent.com/u/1751645?v=4><a href="https://github.com/cunneen">cunneen</a></td>
-<td><img src=https://avatars.githubusercontent.com/u/506460?v=4><a href="https://github.com/Osterjour">Osterjour</a></td>
-</tr><tr><td><img src=https://avatars.githubusercontent.com/u/138707?v=4><a href="https://github.com/th507">th507</a></td>
-<td><img src=https://avatars.githubusercontent.com/u/86159966?v=4><a href="https://github.com/DeutscherDude">Deutscher&shy;Dude</a></td>
+</tr><tr><td><img src=https://avatars.githubusercontent.com/u/506460?v=4><a href="https://github.com/Osterjour">Osterjour</a></td>
+<td><img src=https://avatars.githubusercontent.com/u/138707?v=4><a href="https://github.com/th507">th507</a></td>
+<td><img src=https://avatars.githubusercontent.com/u/242058858?v=4><a href="https://github.com/tiny-rac00n">tiny-rac00n</a></td>
 <td><img src=https://avatars.githubusercontent.com/u/1656140?v=4><a href="https://github.com/eheikes">eheikes</a></td>
 <td><img src=https://avatars.githubusercontent.com/u/1872824?v=4><a href="https://github.com/fgheorghe">fgheorghe</a></td>
 <td><img src=https://avatars.githubusercontent.com/u/498929?v=4><a href="https://github.com/roncli">roncli</a></td>
-<td><img src=https://avatars.githubusercontent.com/u/1355559?v=4><a href="https://github.com/superoven">superoven</a></td>
-</tr><tr><td><img src=https://avatars.githubusercontent.com/u/631249?v=4><a href="https://github.com/airdrummingfool">airdrummingfool</a></td>
+</tr><tr><td><img src=https://avatars.githubusercontent.com/u/1355559?v=4><a href="https://github.com/superoven">superoven</a></td>
+<td><img src=https://avatars.githubusercontent.com/u/631249?v=4><a href="https://github.com/airdrummingfool">airdrummingfool</a></td>
 <td><img src=https://avatars.githubusercontent.com/u/54934?v=4><a href="https://github.com/wmertens">wmertens</a></td>
 <td><img src=https://avatars.githubusercontent.com/u/2842176?v=4><a href="https://github.com/XadillaX">Xadilla&shy;X</a></td>
 <td><img src=https://avatars.githubusercontent.com/u/107884?v=4><a href="https://github.com/inside">inside</a></td>
 <td><img src=https://avatars.githubusercontent.com/u/1320090?v=4><a href="https://github.com/dsbert">dsbert</a></td>
-<td><img src=https://avatars.githubusercontent.com/u/527814?v=4><a href="https://github.com/jacobemerick">jacobemerick</a></td>
 </tr></table>
 
 License
@@ -171,6 +178,5 @@ License
 
 May be freely distributed under the [MIT license](https://raw.githubusercontent.com/node-config/node-config/master/LICENSE).
 
-Copyright (c) 2010-2025 Loren West 
+Copyright (c) 2010-2026 Loren West 
 [and other contributors](https://github.com/node-config/node-config/graphs/contributors)
-

package/async.js

@@ -1,12 +1,33 @@
-var asyncSymbol = Symbol('asyncSymbol');
-var deferConfig = require('./defer').deferConfig;
+const asyncSymbol = Symbol('asyncSymbol');
+const { deferConfig } = require('./defer');
 
+/** @typedef {import('./lib/config').Config} Config */
+/** @typedef {import('./defer').DeferredConfig} DeferredConfig */
+
+/**
+ * @template T
+ * @overload
+ * @param {Promise<T>} promiseOrFunc
+ * @returns {Promise<T>}
+ */
 /**
- * @param promiseOrFunc   the promise will determine a property's value once resolved
+ * @template T
+ * @overload
+ * @param {(config: Config, original: any) => Promise<T>} promiseOrFunc
+ * @returns {DeferredConfig}
+ */
+/**
+ * @template T
+ * @param {Promise<T> | ((config: Config, original: any) => Promise<T>)} promiseOrFunc
+ *                        the promise will determine a property's value once resolved
  *                        can also be a function to defer which resolves to a promise
- * @returns {Promise}     a marked promise to be resolve later using `resolveAsyncConfigs`
+ * @returns {Promise<T> | DeferredConfig} a marked promise to be resolve later using `resolveAsyncConfigs`
+ * @deprecated please use async functions with defer
  */
 function asyncConfig(promiseOrFunc) {
+  const { Util } = require('./lib/util.js');
+  Util.errorOnce("ASYNC_CONFIG", 'config/async.js is deprecated. Please use async functions with the new defer functionality');
+
   if (typeof promiseOrFunc === 'function') {  // also acts as deferConfig
     return deferConfig(function (config, original) {
       var release;
@@ -33,9 +54,10 @@ function asyncConfig(promiseOrFunc) {
 }
 
 /**
- * Do not use `config.get` before executing this method, it will freeze the config object
- * @param config    the main config object, returned from require('config')
- * @returns {Promise<config>}   once all promises are resolved, return the original config object
+ * Do not use `config.get` before executing this method, it will freeze the config object.
+ * @param {Config} config the main config object, returned from require('config')
+ * @returns {Promise<Config>}   once all promises are resolved, return the original config object
+ * @deprecated please use async functions with defer and Util.resolveAsyncConfigs
  */
 function resolveAsyncConfigs(config) {
   var promises = [];

package/defer.js

@@ -1,23 +1,19 @@
-// Create a deferredConfig prototype so that we can check for it when reviewing the configs later.
-function DeferredConfig() {}
-DeferredConfig.prototype.prepare = function() {};
-DeferredConfig.prototype.resolve = function() {};
+const { deferConfig, DeferredConfig } = require('./lib/defer.js');
 
-// Accept a function that we'll use to resolve this value later and return a 'deferred' configuration value to resolve it later.
-function deferConfig(func) {
-  var obj = Object.create(DeferredConfig.prototype);
-  obj.prepare = function(config, prop, property) {
-    var original = prop[property]._original;
-    obj.resolve = function() {
-      var value = func.call(config, config, original);
-      Object.defineProperty(prop, property, {value: value});
-      return value;
-    };
-    Object.defineProperty(prop, property, {get: function() { return obj.resolve(); }});
-    return obj;
-  };
-  return obj;
+/**
+ * @deprecated please use the new callback mechanism
+ * @see lib/defer.js
+ * @type {typeof import('./lib/defer').deferConfig}
+ */
+module.exports.deferConfig = (...args) => {
+  const { Util } = require('./lib/util.js');
+
+  Util.errorOnce("DEFER_CONFIG", 'node-config now supports config file callbacks in place of deferConfig(), which is deprecated.');
+  return deferConfig(...args);
 }
 
-module.exports.deferConfig = deferConfig;
+/**
+ * @deprecated please use the new callback mechanism
+ * @type {typeof import('./lib/defer').DeferredConfig}
+ */
 module.exports.DeferredConfig = DeferredConfig;