docs: refine code comments
authorJérôme Benoit <jerome.benoit@sap.com>
Tue, 25 Jul 2023 22:02:04 +0000 (00:02 +0200)
committerJérôme Benoit <jerome.benoit@sap.com>
Tue, 25 Jul 2023 22:02:04 +0000 (00:02 +0200)
Signed-off-by: Jérôme Benoit <jerome.benoit@sap.com>
src/charging-station/ChargingStationUtils.ts
src/utils/Utils.ts

index 0eeb205189456c4d0ea44ec96d3cfdf434722075..23b42d5c846db9560abdbea12c516c092c3272ad 100644 (file)
@@ -672,8 +672,10 @@ interface ChargingProfilesLimit {
 }
 
 /**
- * Charging profiles should already be sorted by connector id and stack level (highest stack level has priority)
+ * Charging profiles shall already be sorted by connector id and stack level (highest stack level has priority)
  *
+ * @param chargingStation -
+ * @param connectorId -
  * @param chargingProfiles -
  * @param logPrefix -
  * @returns ChargingProfilesLimit
index 54b0751022130ba18e3a238cc58a78d741acb39e..48d0587cbce16e9db798c48877795325e8088eff 100644 (file)
@@ -262,11 +262,12 @@ export const insertAt = (str: string, subStr: string, pos: number): string =>
  * Computes the retry delay in milliseconds using an exponential backoff algorithm.
  *
  * @param retryNumber - the number of retries that have already been attempted
+ * @param maxDelayRatio - the maximum ratio of the delay that can be randomized
  * @returns delay in milliseconds
  */
 export const exponentialDelay = (retryNumber = 0, maxDelayRatio = 0.2): number => {
   const delay = Math.pow(2, retryNumber) * 100;
-  const randomSum = delay * maxDelayRatio * secureRandom(); // 0-20% of the delay
+  const randomSum = delay * maxDelayRatio * secureRandom(); // 0-(maxDelayRatio*100)% of the delay
   return delay + randomSum;
 };