docs: improve code documentation

[e-mobility-charging-stations-simulator.git] / src / utils / Utils.ts

diff --git a/src/utils/Utils.ts b/src/utils/Utils.ts
index 810267200fb1e3b1a4949918f264d8f57e085455..83c1e3f7490a4dd9fff5976c2367a5eb548e7dfa 100644 (file)
--- a/src/utils/Utils.ts
+++ b/src/utils/Utils.ts
@@ -3,10 +3,10 @@ import util from 'node:util';
 
 import clone from 'just-clone';
 
-import Constants from './Constants';
-import { WebSocketCloseEventStatusString } from '../types/WebSocket';
+import { Constants } from './Constants';
+import { WebSocketCloseEventStatusString } from '../types';
 
-export default class Utils {
+export class Utils {
   private constructor() {
     // This is intentional
   }
@@ -121,13 +121,14 @@ export default class Utils {
     return result;
   }
 
-  public static getRandomFloat(max = Number.MAX_VALUE, min = 0, negative = false): number {
-    if (max < min || max < 0 || min < 0) {
+  public static getRandomFloat(max = Number.MAX_VALUE, min = 0): number {
+    if (max < min) {
       throw new RangeError('Invalid interval');
     }
-    const randomPositiveFloat = crypto.randomBytes(4).readUInt32LE() / 0xffffffff;
-    const sign = negative && randomPositiveFloat < 0.5 ? -1 : 1;
-    return sign * (randomPositiveFloat * (max - min) + min);
+    if (max - min === Infinity) {
+      throw new RangeError('Invalid interval');
+    }
+    return (crypto.randomBytes(4).readUInt32LE() / 0xffffffff) * (max - min) + min;
   }
 
   public static getRandomInteger(max = Constants.MAX_RANDOM_INTEGER, min = 0): number {
@@ -139,14 +140,17 @@ export default class Utils {
     return Math.floor(crypto.randomInt(max + 1));
   }
 
+  /**
+   * Rounds the given number to the given scale.
+   * The rounding is done using the "round half away from zero" method.
+   *
+   * @param numberValue - The number to round.
+   * @param scale - The scale to round to.
+   * @returns The rounded number.
+   */
   public static roundTo(numberValue: number, scale: number): number {
     const roundPower = Math.pow(10, scale);
-    return Math.round(numberValue * roundPower) / roundPower;
-  }
-
-  public static truncTo(numberValue: number, scale: number): number {
-    const truncPower = Math.pow(10, scale);
-    return Math.trunc(numberValue * truncPower) / truncPower;
+    return Math.round(numberValue * roundPower * (1 + Number.EPSILON)) / roundPower;
   }
 
   public static getRandomFloatRounded(max = Number.MAX_VALUE, min = 0, scale = 2): number {
@@ -184,6 +188,14 @@ export default class Utils {
     return clone<T>(object);
   }
 
+  public static hasOwnProp(object: unknown, property: PropertyKey): boolean {
+    return Utils.isObject(object) && Object.hasOwn(object as object, property);
+  }
+
+  public static isCFEnvironment(): boolean {
+    return !Utils.isNullOrUndefined(process.env.VCAP_APPLICATION);
+  }
+
   public static isIterable<T>(obj: T): boolean {
     return !Utils.isNullOrUndefined(obj) ? typeof obj[Symbol.iterator] === 'function' : false;
   }
@@ -193,7 +205,14 @@ export default class Utils {
   }
 
   public static isEmptyString(value: unknown): boolean {
-    return Utils.isString(value) && (value as string).trim().length === 0;
+    return (
+      Utils.isNullOrUndefined(value) ||
+      (Utils.isString(value) && (value as string).trim().length === 0)
+    );
+  }
+
+  public static isNotEmptyString(value: unknown): boolean {
+    return Utils.isString(value) && (value as string).trim().length > 0;
   }
 
   public static isUndefined(value: unknown): boolean {
@@ -202,17 +221,15 @@ export default class Utils {
 
   public static isNullOrUndefined(value: unknown): boolean {
     // eslint-disable-next-line eqeqeq, no-eq-null
-    return value == null ? true : false;
+    return value == null;
   }
 
-  public static isEmptyArray(object: unknown | unknown[]): boolean {
-    if (!Array.isArray(object)) {
-      return true;
-    }
-    if (object.length > 0) {
-      return false;
-    }
-    return true;
+  public static isEmptyArray(object: unknown): boolean {
+    return Array.isArray(object) && object.length === 0;
+  }
+
+  public static isNotEmptyArray(object: unknown): boolean {
+    return Array.isArray(object) && object.length > 0;
   }
 
   public static isEmptyObject(obj: object): boolean {
@@ -231,12 +248,14 @@ export default class Utils {
     `${str.slice(0, pos)}${subStr}${str.slice(pos)}`;
 
   /**
+   * Computes the retry delay in milliseconds using an exponential backoff algorithm.
+   *
    * @param retryNumber - the number of retries that have already been attempted
    * @returns delay in milliseconds
    */
-  public static exponentialDelay(retryNumber = 0): number {
+  public static exponentialDelay(retryNumber = 0, maxDelayRatio = 0.2): number {
     const delay = Math.pow(2, retryNumber) * 100;
-    const randomSum = delay * 0.2 * Utils.secureRandom(); // 0-20% of the delay
+    const randomSum = delay * maxDelayRatio * Utils.secureRandom(); // 0-20% of the delay
     return delay + randomSum;
   }
 
@@ -268,7 +287,7 @@ export default class Utils {
   }
 
   /**
-   * Generate a cryptographically secure random number in the [0,1[ range
+   * Generates a cryptographically secure random number in the [0,1[ range
    *
    * @returns
    */
@@ -296,7 +315,7 @@ export default class Utils {
   }
 
   /**
-   * Convert websocket error code to human readable string message
+   * Converts websocket error code to human readable string message
    *
    * @param code - websocket error code
    * @returns human readable string message