Method setModuleDefaults

lib/util.js:1243–1269

* * Set default configurations for a node.js module. * * * * This allows module developers to attach their configurations onto the * default configuration object so they can be configured by the consumers * of the module. * * * Using the function wi

(moduleName, defaultProperties)

   * @return {Object} - The module level configuration object.
   */
  setModuleDefaults(moduleName, defaultProperties) {
    this.updated = true;

    if (this.defaults === undefined) {
      this.defaults = {};
      this.unmerged = {};

      if (this.sources) {
        this.sources.splice(0, 0, { name: 'Module Defaults', parsed: this.defaults });
      }
    }

    const path = moduleName.split('.');
    const defaults = Util.setPath(this.defaults, path, Util.getPath(this.defaults, path) ?? {});

    Util.extendDeep(defaults, defaultProperties);

    const original =
      Util.getPath(this.unmerged, path) ??
      Util.setPath(this.unmerged, path, Util.getPath(this.config, path) ?? {});

    const moduleConfig = Util.extendDeep({}, defaults, original);
    Util.setPath(this.config, path, moduleConfig);
    Util.resolveDeferredConfigs(this.config);

    return moduleConfig;
  }

  /**
   * Parse and return the specified string with the specified format.