webpack-hmr-server - npm Package Compare versions

Comparing version 1.1.5 to 1.1.6

package.json

 {
   "name": "webpack-hmr-server",
-  "version": "1.1.5",
+  "version": "1.1.6",
   "description": "Webpack hot reloading using http server and websocket",
@@ -5,0 +5,0 @@ "main": "./dist/index.js",

README.md

@@ -9,3 +9,3 @@ # webpack-hmr-server
 ![test](https://img.shields.io/badge/ReactJS-success-green)
-![test](https://img.shields.io/badge/VueJS-wait-red)
+![test](https://img.shields.io/badge/VueJS-todo-red)
 ![test](https://img.shields.io/badge/VanillaJS-done-green)
@@ -67,2 +67,16 @@
 
+
+## Example usage for create custom overlay
+
+```ts
+import type { Types } from 'webpack-hmr-server';
+
+document.addEventListener("__webpack_hmr_sever__", (e) => {
+  const { detail } = e as unknown as { detail: unknown };
+  const event = detail as Types.Event;
+
+  // custom logic for overlay
+})
+```
+
 - - -
@@ -92,3 +106,3 @@
 
-if module.hot.check(true) is called in a running application, then a request for JSON will be sent. If successful, modules will be updated
+if ```module.hot.check(true)``` is called in a running application, then a request for JSON will be sent. If successful, modules will be updated
 
@@ -95,0 +109,0 @@ - - -

No alert changes

Improved metrics

Total package byte prevSize

37493

increased by0.81%

Number of lines in readme file

131

increased by11.97%

No dependency changes