qtools-library-dot-d 1.0.7 → 1.0.8

package/README.md

@@ -15,7 +15,7 @@ The "dotD" naming convention (short for "dot-D") refers to directories that cont
 - `accessPoints.d/` - Directory containing data access modules
 - `mappers.d/` - Directory containing data mapping modules
 
-Each `.js` file in a dotD directory becomes a method on the library object, with the filename determining the method name.
+Each module, `.js` file or directory with package.json, in a dotD directory becomes a method on the library object, with the filename determining the method name.
 
 ## Why Use Dynamic dotD Libraries?
 
@@ -30,10 +30,10 @@ const module2 = require('./modules/module2');
 const module3 = require('./modules/module3');
 
 // dotD approach - automatic discovery
-const library = qtLibDotD({ libraryName: 'myLibrary' });
-library.setLibraryPath('./modules.d');
-library.loadModules();
-// All modules in modules.d/ are now available as library.moduleName()
+const myLibrary = qtLibDotD({ libraryName: 'myLibrary' }); //libraryName is used as a label in reports
+myLibrary.setLibraryPath('./modules.d');
+myLibrary.loadModules();
+// All modules in modules.d/ are now available as myLibrary.moduleName()
 ```
 
 ### 2. **Plugin Architecture**
@@ -42,12 +42,12 @@ Create extensible applications where new functionality can be added by simply dr
 
 ```javascript
 // Add new functionality by creating a new file
-// modules.d/newFeature.js -> library.newFeature()
+// modules.d/newFeature.js -> myLibrary.newFeature()
 ```
 
 ### 3. **Shared Resources**
 
-Pass common resources (configuration, database connections, utilities) to all modules through `passThroughParameters`.
+Pass common resources (configuration, database connections, utilities) to all modules through `passThroughParameters`. These are given, by that name, to the module (along with the 'dotD', the library object) when it is instantiated during the loadModules() process.
 
 ```javascript
 const passThroughParameters = {
@@ -56,7 +56,7 @@ const passThroughParameters = {
     logger: xLog,
     utilities: commonUtils
 };
-library.loadModules({ passThroughParameters });
+myLibrary.loadModules({ passThroughParameters });
 ```
 
 ### 4. **Clean Separation of Concerns**
@@ -111,13 +111,13 @@ Modules can be loaded synchronously or asynchronously, and the library can be se
 
 ```javascript
 const qtLibDotD = require('qtools-library-dot-d');
-const library = qtLibDotD({ libraryName: 'myLibrary' });
+const myLibrary = qtLibDotD({ libraryName: 'myLibrary' });
 ```
 
 ### 2. **Module Directory Setup**
 
 ```javascript
-library.setLibraryPath('./modules.d');
+myLibrary.setLibraryPath('./modules.d');
 ```
 
 ### 3. **Shared Resource Definition**
@@ -127,33 +127,33 @@ const passThroughParameters = {
     config: appConfig,
     database: dbConnection,
     logger: logger
-};
+}; //provided by loadModules() in the initialization object
 ```
 
 ### 4. **Module Loading**
 
 ```javascript
 // Synchronous
-library.loadModules({ passThroughParameters });
+myLibrary.loadModules({ passThroughParameters });
 
 // Asynchronous
-library.loadModules({ passThroughParameters }, callback);
+myLibrary.loadModules({ passThroughParameters }, callback);
 ```
 
 ### 5. **Library Sealing**
 
 ```javascript
-library.seal(); // Prevents further modifications
+myLibrary.seal(); // Prevents further modifications
 ```
 
 ### 6. **Module Usage**
 
 ```javascript
 // If you have modules.d/processOrder.js
-library.processOrder(orderData);
+myLibrary.processOrder(orderData);
 
 // If you have modules.d/sendEmail.js  
-library.sendEmail(recipient, message);
+myLibrary.sendEmail(recipient, message);
 ```
 
 ## Module Structure
@@ -201,13 +201,7 @@ module.exports = moduleFunction({ moduleName });
    npm install qtools-library-dot-d
    ```
 
-2. **Run the example:**
-   
-   ```bash
-   npm start
-   ```
-
-3. **Create your own modules:**
+2. **Create your own modules:**
    
    - Add `.js` files to `demoModules_DotD/`
    - Follow the module pattern shown in the examples
@@ -235,7 +229,6 @@ This pattern is used extensively in the qtools ecosystem for building scalable,
 
 ## HISTORY
 
-v1.07 - updated README
+v1.08 - updated README (several times)
 v1.05 - cleaned up toString() report, returns exception list (or err if callback) if needed, added qtools-functional-library
 v1.04 - Now tolerates (and reports) directories and files that are not modules.
-

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "qtools-library-dot-d",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "description": "Scan a directory for JS modules that can execute and addMe() that attaches it to some form of name/value list, eg, a Map() with functions as values or an xPressJS route/endpoint list.",
   "main": "qtools-library-dot-d.js",
   "scripts": {

package/qtools-library-dot-d.js

@@ -14,7 +14,7 @@ const qt = require('qtools-functional-library');
 //START OF moduleFunction() ============================================================
 const moduleFunction =
 	({ moduleName } = {}) =>
-	({ libraryName }) => {
+	({ libraryName='libraryDotD' }) => {
 		// ======================================================================================
 		// SETTERS