config 4.3.0 → 4.4.0

package/lib/defer.js

@@ -1,12 +1,40 @@
 const { isAsyncFunction } = require('node:util/types');
 
-// Create a deferredConfig prototype so that we can check for it when reviewing the configs later.
+/** @typedef {import('./config').Config} Config */
+
+/**
+ * Deferred config placeholder.
+ * @constructor
+ */
 function DeferredConfig() {}
-DeferredConfig.prototype.prepare = function() {};
+
+/**
+ * Prepare this deferred value for lazy resolution.
+ *
+ * @param {Config} config
+ * @param {any} prop
+ * @param {string | number} property
+ * @returns {DeferredConfig}
+ */
+DeferredConfig.prototype.prepare = function(config, prop, property) {};
+
+/**
+ * Resolve the deferred value.
+ *
+ * @returns {any}
+ */
 DeferredConfig.prototype.resolve = function() {};
 
-// Accept a function that we'll use to resolve this value later and return a 'deferred' configuration value to resolve it later.
+/**
+ * Accept a function that we will execute later and return a deferred placeholder.
+ *
+ * @template TOriginal
+ * @template TResult
+ * @param {(this: Config, config: Config, original: TOriginal) => TResult | Promise<TResult>} func
+ * @returns {DeferredConfig}
+ */
 function deferConfig(func) {
+  /** @type {DeferredConfig} */
   const obj = Object.create(DeferredConfig.prototype);
   obj.prepare = function(config, prop, property) {
     const original = prop[property]._original;