]> Piment Noir Git Repositories - e-mobility-charging-stations-simulator.git/commitdiff
docs: fix inaccurate @returns in getChargingProfilesLimit
authorJérôme Benoit <jerome.benoit@sap.com>
Tue, 24 Mar 2026 17:01:10 +0000 (18:01 +0100)
committerJérôme Benoit <jerome.benoit@sap.com>
Tue, 24 Mar 2026 17:01:10 +0000 (18:01 +0100)
Return type can be undefined but JSDoc only documented the non-null case.

src/charging-station/Helpers.ts

index 3056a7bb741e4365250753d85b88d20bde9c3405..885506a07056dfd8c3f0e060ce25e5496f084d82 100644 (file)
@@ -1072,7 +1072,7 @@ const getSingleChargingSchedule = (
  * @param chargingStation - The charging station instance
  * @param connectorId - The connector identifier
  * @param chargingProfiles - Array of charging profiles
- * @returns ChargingProfilesLimit
+ * @returns Charging profiles limit or undefined if no valid limit found
  */
 const getChargingProfilesLimit = (
   chargingStation: ChargingStation,