@xeplr/base-apis 3.0.1 → 3.0.2

package/README.md

@@ -80,6 +80,7 @@ createApp(3000, 'myapp', {
 | option | |
 |---|---|
 | `requiredEnv` | variable names; any missing → message and `process.exit(1)` before anything starts |
+| `host` | the address to listen on, e.g. `'127.0.0.1'` for a service that only nginx on the same machine may reach. Default: every address |
 | `auth` | the gate — see below. **On when omitted** |
 | `middleware` | array, mounted after the gate |
 | `rawBodyPaths` | path prefixes whose body is also kept byte for byte as `req.rawBody` (a `Buffer`) — see below |

package/express.js

@@ -14,6 +14,8 @@ var logs = require('@xeplr/logs');
  * @param {string}        appName    - Service name (used for debug namespace and console logs)
  * @param {object}        [options]  - Configuration options
  * @param {string[]}      [options.requiredEnv]   - Mandatory env var names; missing ones abort startup
+ * @param {string}        [options.host]          - The address to listen on, e.g. '127.0.0.1' for a service only a
+ *   proxy on the same machine may reach. Default: every address (Node's own default).
  * @param {object}        [options.routes]        - Route map: { '/path': router }
  * @param {object|false}  [options.auth]          - THE GATE, ON BY DEFAULT.
  *   Omit it and every route requires a valid token, validated by asking the
@@ -251,7 +253,7 @@ function createApp(port, appName, options) {
 
   // ── Start HTTP server ──
   app.set('port', port);
-  var server = createServer(app, port, appName);
+  var server = createServer(app, port, appName, options.host);
 
   return { app: app, server: server };
 }

package/lib/server.js

@@ -7,12 +7,14 @@ function normalizePort(val) {
   return false;
 }
 
-function createServer(handler, port, name) {
+function createServer(handler, port, name, host) {
   const dbg = require('debug')('architects:' + name);
   const normalizedPort = normalizePort(port);
 
   const server = http.createServer(handler);
-  server.listen(normalizedPort);
+  // A host only for a port: a named pipe has none.
+  if (host && typeof normalizedPort === 'number') server.listen(normalizedPort, host);
+  else server.listen(normalizedPort);
 
   server.on('error', function onError(error) {
     if (error.syscall !== 'listen') throw error;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xeplr/base-apis",
-  "version": "3.0.1",
+  "version": "3.0.2",
   "description": "Base API bootstrapper — Express and plain HTTP server factories with middleware injection",
   "main": "index.js",
   "bin": {