@caboodle-tech/node-simple-server 4.2.2 → 4.2.4

package/README.md

@@ -283,6 +283,10 @@ With your new instance of NSS you can call any of the following public methods:
 
 -   Send a message (`msg`) via WebSocket to the page that matches the `pageId`, or send to a page or pages that match the `pattern`.
 
+### **printListeningAddresses(\[returnInstead = false\])**
+
+-   Prints a message to console with all the addresses the server is available at. If you want full control of the printing you can set `returnInstead` to `true`.
+
 #### **reloadPages()**
 
 -   Sends the reload signal to all active pages.
@@ -303,9 +307,9 @@ With your new instance of NSS you can call any of the following public methods:
 
 -   Unregister (stop messaging) a `callback` function that was initially registered with the `pattern`.
 
-#### **start(\[callback\]) | start(\[port\], \[callback\])**
+#### **start(\[callback\]) | start(\[port\], \[callback\], [printAddresses=true])**
 
--   Starts the HTTP and WebSocket servers and notifies `callback` if present. `Port` is meant to be an internal option for NSS only but you may specify a port number for NSS to use if you have strict requirements in your environment. NOTE: This is a blocking process and will keep any application that ran it alive until stopped gracefully or forcefully terminated. If you do not want this behavior for any reason you will need to call this in its own process.
+-   Starts the HTTP and WebSocket servers and notifies `callback` if present. `Port` is meant to be an internal option for NSS only but you may specify a port number for NSS to use if you have strict requirements in your environment. NOTE: This is a blocking process and will keep any application that ran it alive until stopped gracefully or forcefully terminated. If you do not want this behavior for any reason you will need to call this in its own process. Set `printAddresses` to `false` if you want to hide or print the server address on your own.
 
 #### **stop(\[callback\])**
 

package/bin/nss.js

@@ -44,7 +44,7 @@ class NodeSimpleServer {
         map: {}
     };
 
-    #VERSION = '4.2.1';
+    #VERSION = '4.2.4';
 
     #watching = [];
 
@@ -373,6 +373,27 @@ class NodeSimpleServer {
         };
     }
 
+    /**
+     * Print the addresses the server is listening on to the console; this is useful for users who
+     * are not sure what address to use to access the server.
+     *
+     * @param {boolean} [returnInstead=false] If true the function will return the message string instead.
+     */
+    // eslint-disable-next-line consistent-return
+    printListeningAddresses(returnInstead = false) {
+        let message = 'Node Simple Server live @:\n';
+        const addresses = this.getAddresses(this.#OPS.port);
+        addresses.forEach((address) => {
+            message += `    ${address}\n`;
+        });
+        message += '\n';
+
+        if (returnInstead) {
+            return message;
+        }
+        Print.notice(message);
+    }
+
     /**
      * Converts a regular expression (regex) string into an actual RegExp object.
      *
@@ -859,9 +880,11 @@ class NodeSimpleServer {
      *                        this, it's meant to be used internally to NSS.
      * @param {function} [callback] Optional function to call when the server successfully starts
      *                              (true) or gives up on trying to start (false);
+     * @param {boolean} [printAddresses=true] If true the server will print out all the
+     *                                                 addresses it is listening on.
      * @return {void} Used only as a short circuit.
      */
-    start(port, callback) {
+    start(port, callback, printAddresses = true) {
 
         // Port is usually internal to NSS so check if a user placed the callback first.
         if (port && typeof port === 'function') {
@@ -952,12 +975,9 @@ class NodeSimpleServer {
             this.#OPS.portInUse = port;
 
             // Log the ip addresses being watched.
-            Print.notice('Node Simple Server live @:');
-            const addresses = this.getAddresses(port);
-            addresses.forEach((address) => {
-                Print.notice(`    ${address}`);
-            });
-            Print.log('');
+            if (printAddresses) {
+                this.printListeningAddresses(port);
+            }
 
             // Notify the callback.
             if (callback) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@caboodle-tech/node-simple-server",
-    "version": "4.2.2",
+    "version": "4.2.4",
     "description": "Node Simple Server (NSS): A small but effective node based server for development sites, customizable live reloading, and websocket support built-in.",
     "main": "bin/nss.js",
     "scripts": {