refactor: code

Author: alexander-akait

DOCUMENTATION-v4.md

@@ -1087,7 +1087,7 @@ internally within the server.
 module.exports = {
   // ...
   devServer: {
-    onAfterSetupMiddleware (devServer) {
+    onAfterSetupMiddleware(devServer) {
       if (!devServer) {
         throw new Error("webpack-dev-server is not defined");
       }
@@ -1118,7 +1118,7 @@ example:
 module.exports = {
   // ...
   devServer: {
-    onBeforeSetupMiddleware (devServer) {
+    onBeforeSetupMiddleware(devServer) {
       if (!devServer) {
         throw new Error("webpack-dev-server is not defined");
       }
@@ -1147,12 +1147,12 @@ Provides the ability to execute a custom function when webpack-dev-server starts
 module.exports = {
   // ...
   devServer: {
-    onListening (devServer) {
+    onListening(devServer) {
       if (!devServer) {
         throw new Error("webpack-dev-server is not defined");
       }
 
-      const {port} = devServer.server.address();
+      const { port } = devServer.server.address();
       console.log("Listening on port:", port);
     },
   },
@@ -1394,7 +1394,7 @@ module.exports = {
     proxy: {
       "/api": {
         target: "http://localhost:3000",
-        bypass (req, res, proxyOptions) {
+        bypass(req, res, proxyOptions) {
           if (req.headers.accept.includes("html")) {
             console.log("Skipping proxy for browser request.");
             return "/index.html";

README.md

@@ -229,16 +229,16 @@ If you use TypeScript in the webpack config, you'll need to properly type `devSe
 
 ```ts
 /// <reference path="node_modules/webpack-dev-server/types/lib/Server.d.ts"/>
-import  { type Configuration } from "webpack";
+import { type Configuration } from "webpack";
 
 // Your logic
 ```
 
 Or you can import the type from `webpack-dev-server`, i.e.
 
 ```ts
-import  { type Configuration } from "webpack";
-import  { type Configuration as DevServerConfiguration } from "webpack-dev-server";
+import { type Configuration } from "webpack";
+import { type Configuration as DevServerConfiguration } from "webpack-dev-server";
 
 const devServer: DevServerConfiguration = {};
 const config: Configuration = { devServer };

client-src/clients/SockJSClient.js

@@ -1,9 +1,11 @@
 import SockJS from "../modules/sockjs-client/index.js";
 import { log } from "../utils/log.js";
 
+/** @typedef {import("../index").EXPECTED_ANY} EXPECTED_ANY */
+
 export default class SockJSClient {
   /**
-   * @param {string} url
+   * @param {string} url url
    */
   constructor(url) {
     // SockJS requires `http` and `https` protocols
@@ -12,38 +14,38 @@ export default class SockJSClient {
     );
     this.sock.onerror =
       /**
-       * @param {Error} error
+       * @param {Error} error error
        */
       (error) => {
         log.error(error);
       };
   }
 
   /**
-   * @param {(...args: any[]) => void} f
+   * @param {(...args: EXPECTED_ANY[]) => void} fn function
    */
-  onOpen(f) {
-    this.sock.onopen = f;
+  onOpen(fn) {
+    this.sock.onopen = fn;
   }
 
   /**
-   * @param {(...args: any[]) => void} f
+   * @param {(...args: EXPECTED_ANY[]) => void} fn function
    */
-  onClose(f) {
-    this.sock.onclose = f;
+  onClose(fn) {
+    this.sock.onclose = fn;
   }
 
   // call f with the message string as the first argument
   /**
-   * @param {(...args: any[]) => void} f
+   * @param {(...args: EXPECTED_ANY[]) => void} fn function
    */
-  onMessage(f) {
+  onMessage(fn) {
     this.sock.onmessage =
       /**
-       * @param {Error & { data: string }} e
+       * @param {Error & { data: string }} err error
        */
-      (e) => {
-        f(e.data);
+      (err) => {
+        fn(err.data);
       };
   }
 }

client-src/clients/WebSocketClient.js

@@ -1,8 +1,10 @@
 import { log } from "../utils/log.js";
 
+/** @typedef {import("../index").EXPECTED_ANY} EXPECTED_ANY */
+
 export default class WebSocketClient {
   /**
-   * @param {string} url
+   * @param {string} url url to connect
    */
   constructor(url) {
     this.client = new WebSocket(url);
@@ -12,26 +14,26 @@ export default class WebSocketClient {
   }
 
   /**
-   * @param {(...args: any[]) => void} f
+   * @param {(...args: EXPECTED_ANY[]) => void} fn function
    */
-  onOpen(f) {
-    this.client.onopen = f;
+  onOpen(fn) {
+    this.client.onopen = fn;
   }
 
   /**
-   * @param {(...args: any[]) => void} f
+   * @param {(...args: EXPECTED_ANY[]) => void} fn function
    */
-  onClose(f) {
-    this.client.onclose = f;
+  onClose(fn) {
+    this.client.onclose = fn;
   }
 
   // call f with the message string as the first argument
   /**
-   * @param {(...args: any[]) => void} f
+   * @param {(...args: EXPECTED_ANY[]) => void} fn function
    */
-  onMessage(f) {
-    this.client.onmessage = (e) => {
-      f(e.data);
+  onMessage(fn) {
+    this.client.onmessage = (err) => {
+      fn(err.data);
     };
   }
 }