webpack-dev-server - npm Package Compare versions

Comparing version 4.12.0 to 4.13.0

bin/cli-flags.js

@@ -156,2 +156,19 @@ "use strict";
   },
+  "client-overlay-runtime-errors": {
+    configs: [
+      {
+        type: "boolean",
+        multiple: false,
+        description:
+          "Enables a full-screen overlay in the browser when there are uncaught runtime errors.",
+        negatedDescription:
+          "Disables the full-screen overlay in the browser when there are uncaught runtime errors.",
+        path: "client.overlay.runtimeErrors",
+      },
+    ],
+    description:
+      "Enables a full-screen overlay in the browser when there are uncaught runtime errors.",
+    simpleType: "boolean",
+    multiple: false,
+  },
   "client-progress": {
@@ -158,0 +175,0 @@ configs: [

client/index.js

@@ -23,3 +23,3 @@ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
  * @property {boolean} progress
- * @property {boolean | { warnings?: boolean, errors?: boolean, trustedTypesPolicyName?: string }} overlay
+ * @property {boolean | { warnings?: boolean, errors?: boolean, runtimeErrors?: boolean, trustedTypesPolicyName?: string }} overlay
  * @property {string} [logging]
@@ -83,3 +83,4 @@ * @property {number} [reconnect]
       errors: true,
-      warnings: true
+      warnings: true,
+      runtimeErrors: true
     }, options.overlay);
@@ -111,6 +112,11 @@ }
 });
-var trustedTypesPolicyName = typeof options.overlay === "object" && options.overlay.trustedTypesPolicyName;
-var overlay = createOverlay({
-  trustedTypesPolicyName: trustedTypesPolicyName
-});
+var overlay = typeof window !== "undefined" ? createOverlay(typeof options.overlay === "object" ? {
+  trustedTypesPolicyName: options.overlay.trustedTypesPolicyName,
+  catchRuntimeError: options.overlay.runtimeErrors
+} : {
+  trustedTypesPolicyName: false,
+  catchRuntimeError: options.overlay
+}) : {
+  send: function send() {}
+};
 var onSocketMessage = {
@@ -117,0 +123,0 @@ hot: function hot() {

client/overlay.js

@@ -62,2 +62,3 @@ function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
  * @property {string | null} trustedTypesPolicyName
+ * @property {boolean} [catchRuntimeError]
  */
@@ -229,20 +230,22 @@
   });
-  listenToRuntimeError(function (errorEvent) {
-    // error property may be empty in older browser like IE
-    var error = errorEvent.error,
-      message = errorEvent.message;
-    if (!error && !message) {
-      return;
-    }
-    var errorObject = error instanceof Error ? error : new Error(error || message);
-    overlayService.send({
-      type: "RUNTIME_ERROR",
-      messages: [{
-        message: errorObject.message,
-        stack: parseErrorToStacks(errorObject)
-      }]
+  if (options.catchRuntimeError) {
+    listenToRuntimeError(function (errorEvent) {
+      // error property may be empty in older browser like IE
+      var error = errorEvent.error,
+        message = errorEvent.message;
+      if (!error && !message) {
+        return;
+      }
+      var errorObject = error instanceof Error ? error : new Error(error || message);
+      overlayService.send({
+        type: "RUNTIME_ERROR",
+        messages: [{
+          message: errorObject.message,
+          stack: parseErrorToStacks(errorObject)
+        }]
+      });
     });
-  });
+  }
   return overlayService;
 };
 export { formatProblem, createOverlay };

lib/options.json

@@ -114,2 +114,9 @@ {
             },
+            "runtimeErrors": {
+              "description": "Enables a full-screen overlay in the browser when there are uncaught runtime errors.",
+              "type": "boolean",
+              "cli": {
+                "negatedDescription": "Disables the full-screen overlay in the browser when there are uncaught runtime errors."
+              }
+            },
             "trustedTypesPolicyName": {
@@ -116,0 +123,0 @@ "description": "The name of a Trusted Types policy for the overlay. Defaults to 'webpack-dev-server#overlay'.",

package.json

 {
   "name": "webpack-dev-server",
-  "version": "4.12.0",
+  "version": "4.13.0",
   "description": "Serves a webpack app. Updates the browser on changes.",
@@ -5,0 +5,0 @@ "bin": "bin/webpack-dev-server.js",

types/bin/cli-flags.d.ts

@@ -117,2 +117,14 @@ declare const _exports: {
   };
+  "client-overlay-runtime-errors": {
+    configs: {
+      type: string;
+      multiple: boolean;
+      description: string;
+      negatedDescription: string;
+      path: string;
+    }[];
+    description: string;
+    simpleType: string;
+    multiple: boolean;
+  };
   "client-progress": {
@@ -119,0 +131,0 @@ configs: {

No alert changes

Improved metrics

Total package byte prevSize

616463

increased by0.07%

Lines of code

17703

increased by0.11%

No dependency changes