slower 2.1.6 → 2.1.8

package/package.json

@@ -3,7 +3,7 @@
 		"path-to-regexp": "^6.2.2"
 	},
 	"name": "slower",
-	"version": "2.1.6",
+	"version": "2.1.8",
 	"main": "index.js",
 	"devDependencies": {},
 	"scripts": {

package/src/decorators.js

@@ -4,14 +4,14 @@ const utils = require('./utils');
 
 /**
  * Receives and configures the HTTP Response object
- * @param {http.ServerResponse} response 
- * @returns {http.ServerResponse} 
+ * @param {http.ServerResponse} response
+ * @returns {http.ServerResponse}
  * @exposes .status()
  * @exposes .send()
  * @exposes .json()
  * @exposes .file()
  */
-function setupResponse (response) {
+function setupResponse(response) {
     /**
      * Sets the response status code
      * @chainable
@@ -27,10 +27,10 @@ function setupResponse (response) {
      * Sets a response header to a specified value
      * @chainable
      * @overload
-     * @param {string} header 
-     * @param {string} value 
+     * @param {string} header
+     * @param {string} value
      * @returns {http.ServerResponse}
-     * @info Pass in an object of "header":"value" entries 
+     * @info Pass in an object of "header":"value" entries
      *       to set multiple headers at once
      * @example
      *  res.set('Content-Length', 1000)
@@ -45,22 +45,19 @@ function setupResponse (response) {
      *  res.set({ 'Content-Length':1000, 'Content-Type':'text/plain' })
      */
     response.set = function (header, value) {
-        if (typeof header === 'string')
-            response.setHeader(header, value);
-        else
-            for (let prop of header)
-                response.setHeader(prop, header[prop]);
+        if (typeof header === 'string') response.setHeader(header, value);
+        else for (let prop of header) response.setHeader(prop, header[prop]);
         return response;
-    }
+    };
 
     /**
      * An alias for 'res.getHeader()'.
-     * @param {string} header 
+     * @param {string} header
      * @returns {string}
      */
-    response.get = function(header) {
+    response.get = function (header) {
         return response.getHeader(header);
-    }
+    };
 
     /**
      * Sets the Content-Type header with a specific MIME type.
@@ -70,32 +67,36 @@ function setupResponse (response) {
      * @info And if no type is specified, binary type is used (application/octet-stream)
      */
     response.type = function (mime) {
-        let mimetype = MIME_TABLE[mime] || mime || MIME_TABLE[extension] || MIME_TABLE['default'];
+        let mimetype =
+            MIME_TABLE[mime] ||
+            mime ||
+            MIME_TABLE[extension] ||
+            MIME_TABLE['default'];
         response.setHeader('Content-type', mimetype);
         return response;
-    }
+    };
 
     /**
      * Sends a string or buffer as JSON and ends the response
-     * @param {string|Buffer} data 
+     * @param {string|Buffer} data
      * @returns {undefined}
      */
-    response.json = function json (data) {
+    response.json = function json(data) {
         if (response.statusCode === undefined) response.status(200);
         response.setHeader('Content-type', 'application/json');
         response.write(JSON.stringify(data));
         response.end();
         return undefined;
-    }
+    };
 
     /**
      * Sends a string or buffer as HTML data and ends the response
-     * @param {string|Buffer} data 
+     * @param {string|Buffer} data
      * @returns {undefined}
      */
     response.send = function (data) {
         if (response.statusCode === undefined) response.status(200);
-        if (!response.getHeader('Content-Type')) 
+        if (!response.getHeader('Content-Type'))
             response.setHeader('Content-Type', 'text/html');
         response.write(data);
         response.end();
@@ -110,41 +111,46 @@ function setupResponse (response) {
     response.file = function (filename) {
         if (response.statusCode === undefined) response.status(200);
         if (!response.getHeader('Content-Type')) {
-            let extension = (filename||'').split('.').slice(-1)[0];
-            response.setHeader('Content-Type', MIME_TABLE[extension] || MIME_TABLE['default']);
+            let extension = (filename || '').split('.').slice(-1)[0];
+            response.setHeader(
+                'Content-Type',
+                MIME_TABLE[extension] || MIME_TABLE['default']
+            );
         }
         const stream = fs.createReadStream(filename);
         stream.pipe(response);
         return undefined;
-    }
+    };
 
     /**
-    * Renders an HTML document and sends it to client
-    * @param {string} filename The file to use as rendering View
-    * @param {object} locals The properties to replace in the View
-    * @info The locals object may contain either strings or functions or objects with 'toString' method.
-    * @returns {undefined}
-    * @example
-    *   // In 'home.html:
-    *       <h2>{{user}}</h2> has <h2>{{count}}</h2> items
-    *   // In server.js: (generates a new random item for each request)
-    *       res.render('./views/home.html', { user: 'Mike', count: () => randomInt() });
-    */
+     * Renders an HTML document and sends it to client
+     * @param {string} filename The file to use as rendering View
+     * @param {object} locals The properties to replace in the View
+     * @info The locals object may contain either strings or functions or objects with 'toString' method.
+     * @returns {undefined}
+     * @example
+     *   // In 'home.html:
+     *       <h2>{{user}}</h2> has <h2>{{count}}</h2> items
+     *   // In server.js: (generates a new random item for each request)
+     *       res.render('./views/home.html', { user: 'Mike', count: () => randomInt() });
+     */
     response.render = function (filename, locals = {}) {
         let html = fs.readFileSync(filename, 'utf-8');
         for (let item in locals) {
             html = html.replace(
-                new RegExp('{{'+item+'}}', 'gim'), 
-                typeof locals[item] === 'function' ?
-                    locals[item]() : locals[item]?.toString() || ''
+                new RegExp('{{' + item + '}}', 'gim'),
+                typeof locals[item] === 'function'
+                    ? locals[item]()
+                    : locals[item]?.toString() || ''
             );
         }
-        response.setHeader('Content-type', 'text/html');
+        if (!response.getHeader('Content-Type'))
+            response.setHeader('Content-type', 'text/html');
         response.write(html);
         response.end();
         return undefined;
-    }
-        
+    };
+
     /**
      * Sets the 'Location' header and redirects to a given path, URL, or link.
      * @param {string} location An URL, link, path, or the string 'back' to set the target
@@ -160,47 +166,53 @@ function setupResponse (response) {
      *      res.status(300).redirect('http://example.com');
      */
     response.redirect = function (location) {
-        response.setHeader('Location', location === 'back' ? request.getHeader('Referrer') : location || '/');
+        response.setHeader(
+            'Location',
+            location === 'back'
+                ? request.getHeader('Referrer')
+                : location || '/'
+        );
         response.end();
         return undefined;
-    }
-
+    };
 
     return response;
 }
 
 /**
  * Receives and configures the HTTP Request object
- * @param {http.IncomingMessage} request 
+ * @param {http.IncomingMessage} request
  * @returns {http.IncomingMessage}
  * @exposes req.body
  * @exposes req.urlParts
  * @exposes req.query
  * @exposes req.session = { port, rport, host, rhost }
  */
-function setupRequest (request) {
+function setupRequest(request) {
     /**
      * @property
      * Holds the request body data as a buffer
      */
-    return new Promise (resolve => {
+    return new Promise(resolve => {
         // Set classical socket locals
         request.session = {
             port: request.socket.localPort,
             rport: request.socket.remotePort,
             host: utils.normalizeAddress(request.socket.localAddress),
-            rhost: utils.normalizeAddress(request.socket.remoteAddress)
+            rhost: utils.normalizeAddress(request.socket.remoteAddress),
         };
 
-        
+        // Set express-compatible locals
+        request.ip = request.session.rhost;
+
         /**
          * An alias for 'req.getHeader()'.
-         * @param {string} header 
+         * @param {string} header
          * @returns {string}
          */
-        request.get = function(header) {
+        request.get = function (header) {
             return request.getHeader(header);
-        }
+        };
 
         // Add req.params placeholder, it is added in the main router, not here
         request.params = undefined;
@@ -212,17 +224,17 @@ function setupRequest (request) {
         request.body = [];
         request.on('timeout', () => reject(new Error('Timeout')));
         request.on('data', chunk => request.body.push(chunk));
-        request.on('error', (err) => reject(err));
+        request.on('error', err => reject(err));
         request.on('end', () => {
             let tmp = Buffer.concat(request.body);
             request.body = {
                 buffer: tmp,
                 text: () => tmp.toString(),
-                json: () => JSON.parse(tmp)
-            }
+                json: () => JSON.parse(tmp),
+            };
             return resolve(request);
         });
     });
 }
 
-module.exports = { setupRequest, setupResponse };
+module.exports = { setupRequest, setupResponse };

package/src/slower.js

@@ -412,6 +412,7 @@ class SlowerMicroRouter {
             this[verb] = function (...callbacks) {
                 for (let callback of callbacks)
                     this.#setRoute(verb, callback);
+		return this;
             };
         }
     }