@cley_faye/boilerplate 3.7.2 → 3.8.0

package/README.md

@@ -426,7 +426,7 @@ import {appStart} from "@cley_faye/boilerplate/lib/express.js";
 
 appStart({
   app,
-  allowNonLocal: false,
+  listenInterface: false,
   port: 3000,
   shutdownFunction: () => {;},
   logger: consoleLogger,
@@ -435,7 +435,8 @@ appStart({
 
 The settings are:
 
-- allowNonLocal: listen only to localhost or not
+- listenInterface: listen only to localhost or not. Can also be used to specify the address of an
+  interface to bind to.
 - port: port to listen to. Can be 0 to use a random available port
 - shutdownFunction: a function to call after the server stop listening
 - logger: a winston logger to log that the server started listening

package/lib/express.d.ts

@@ -106,7 +106,16 @@ export declare const createPipeline: (settings: PipelineSettings, debugLog?: Log
 export declare const setViewEngine: (app: express.Express, viewEngine: string, viewsDirectory: string, extraLocals?: Record<string, string | number> | undefined) => void;
 export interface StartDefinition {
     app: express.Application;
+    /** @deprecated use listenInterface instead */
     allowNonLocal?: boolean;
+    /**
+     * Which interface to listen on.
+     *
+     * Defaults to `false` which means listen only on localhost.
+     * Set to `true` to listen on all interfaces
+     * Set to an IP to bind on a specific interface.
+     */
+    listenInterface?: boolean | string;
     port?: number;
     shutdownFunction?: () => void;
     logger?: winston.Logger;
@@ -135,4 +144,4 @@ export interface StartResult {
  *
  * @property server
  */
-export declare const appStart: ({ app, allowNonLocal, port, shutdownFunction, logger, }: StartDefinition) => Promise<StartResult>;
+export declare const appStart: ({ app, allowNonLocal, listenInterface, port, shutdownFunction, logger, }: StartDefinition) => Promise<StartResult>;

package/lib/express.js

@@ -169,7 +169,7 @@ exports.setViewEngine = setViewEngine;
  *
  * @property server
  */
-const appStart = ({ app, allowNonLocal, port, shutdownFunction, logger, }) => new Promise(resolve => {
+const appStart = ({ app, allowNonLocal, listenInterface, port, shutdownFunction, logger, }) => new Promise(resolve => {
     let server = null;
     const readyCallback = () => {
         if (server === null) {
@@ -186,9 +186,18 @@ const appStart = ({ app, allowNonLocal, port, shutdownFunction, logger, }) => ne
             server,
         });
     };
-    server = allowNonLocal
-        ? app.listen(port ?? 0, readyCallback)
-        : app.listen(port ?? 0, "localhost", readyCallback);
+    if (allowNonLocal !== undefined && listenInterface !== undefined) {
+        throw new Error("You can't specify both allowNonLocal and listenInterface at the same time");
+    }
+    if (allowNonLocal || listenInterface === true) {
+        server = app.listen(port ?? 0, readyCallback);
+    }
+    else if (typeof listenInterface === "string") {
+        server = app.listen(port ?? 0, listenInterface, readyCallback);
+    }
+    else {
+        server = app.listen(port ?? 0, "localhost", readyCallback);
+    }
     if (shutdownFunction) {
         server.on("close", shutdownFunction);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cley_faye/boilerplate",
-  "version": "3.7.2",
+  "version": "3.8.0",
   "description": "Boilerplate code generator for generic projects",
   "repository": {
     "type": "git",