Add JSDoc.
authorJérôme Benoit <jerome.benoit@piment-noir.org>
Sun, 4 Apr 2021 19:44:12 +0000 (21:44 +0200)
committerJérôme Benoit <jerome.benoit@piment-noir.org>
Sun, 4 Apr 2021 19:44:12 +0000 (21:44 +0200)
Signed-off-by: Jérôme Benoit <jerome.benoit@piment-noir.org>
src/charging-station/StationWorker.ts

index 20fb27ca04ae47a533f7109525f07a8e7bba1768..84cb023b7334297d751f3bf51f7515223eac2575 100644 (file)
@@ -19,7 +19,7 @@ if (Utils.workerPoolInUse()) {
 }
 
 /**
- *
+ * Listen messages send by the main thread
  */
 function addMessageListener(): void {
   parentPort.on('message', (message) => {
@@ -30,7 +30,9 @@ function addMessageListener(): void {
 }
 
 /**
- * @param data
+ * Create and start a charging station instance
+ *
+ * @param {StationWorkerData} data workerData
  */
 function startChargingStation(data: StationWorkerData): void {
   const station = new ChargingStation(data.index, data.templateFile);