Improve a bit JSDoc.

[e-mobility-charging-stations-simulator.git] / src / worker / WorkerSet.ts

diff --git a/src/worker/WorkerSet.ts b/src/worker/WorkerSet.ts
index 0c59c09108089d059184bcaac99e6ffc104c3341..bf8b70210cc289efd0db0e631b12cf72d7099e4a 100644 (file)
--- a/src/worker/WorkerSet.ts
+++ b/src/worker/WorkerSet.ts
@@ -1,13 +1,13 @@
-import { WorkerData, WorkerEvents, WorkerSetElement } from '../types/Worker';
+import { WorkerEvents, WorkerSetElement } from '../types/Worker';
 
 import Constants from '../utils/Constants';
 import Utils from '../utils/Utils';
 import { Worker } from 'worker_threads';
-import Wrk from './Wrk';
+import WorkerAbstract from './WorkerAbstract';
 
-export default class WorkerSet extends Wrk {
+export default class WorkerSet<T> extends WorkerAbstract {
   public maxElementsPerWorker: number;
-  private workers: Set<WorkerSetElement>;
+  private workerSet: Set<WorkerSetElement>;
 
   /**
    * Create a new `WorkerSet`.
@@ -17,21 +17,22 @@ export default class WorkerSet extends Wrk {
    */
   constructor(workerScript: string, maxElementsPerWorker = 1) {
     super(workerScript);
-    this.workers = new Set<WorkerSetElement>();
+    this.workerSet = new Set<WorkerSetElement>();
     this.maxElementsPerWorker = maxElementsPerWorker;
   }
 
   get size(): number {
-    return this.workers.size;
+    return this.workerSet.size;
   }
 
   /**
    *
-   * @return {Promise<void>}
+   * @param elementData
+   * @returns {Promise<void>}
    * @public
    */
-  public async addElement(elementData: WorkerData): Promise<void> {
-    if (!this.workers) {
+  public async addElement(elementData: T): Promise<void> {
+    if (!this.workerSet) {
       throw Error('Cannot add a WorkerSet element: workers\' set does not exist');
     }
     if (this.getLastWorkerSetElement().numberOfWorkerElements >= this.maxElementsPerWorker) {
@@ -45,7 +46,7 @@ export default class WorkerSet extends Wrk {
 
   /**
    *
-   * @return {Promise<void>}
+   * @returns {Promise<void>}
    * @public
    */
   public async start(): Promise<void> {
@@ -56,7 +57,18 @@ export default class WorkerSet extends Wrk {
 
   /**
    *
-   * @return {Promise}
+   * @returns {Promise<void>}
+   * @public
+   */
+  public async stop(): Promise<void> {
+    for (const workerSetElement of this.workerSet) {
+      await workerSetElement.worker.terminate();
+    }
+    this.workerSet.clear();
+  }
+
+  /**
+   *
    * @private
    */
   private startWorker(): void {
@@ -67,15 +79,15 @@ export default class WorkerSet extends Wrk {
       if (code !== 0) {
         console.error(`Worker stopped with exit code ${code}`);
       }
-      // FIXME: remove matching worker set element
+      this.workerSet.delete(this.getWorkerSetElementByWorker(worker));
     });
-    this.workers.add({ worker, numberOfWorkerElements: 0 });
+    this.workerSet.add({ worker, numberOfWorkerElements: 0 });
   }
 
   private getLastWorkerSetElement(): WorkerSetElement {
     let workerSetElement: WorkerSetElement;
     // eslint-disable-next-line no-empty
-    for (workerSetElement of this.workers) { }
+    for (workerSetElement of this.workerSet) { }
     return workerSetElement;
   }
 
@@ -85,7 +97,7 @@ export default class WorkerSet extends Wrk {
 
   private getWorkerSetElementByWorker(worker: Worker): WorkerSetElement {
     let workerSetElt: WorkerSetElement;
-    this.workers.forEach((workerSetElement) => {
+    this.workerSet.forEach((workerSetElement) => {
       if (JSON.stringify(workerSetElement.worker) === JSON.stringify(worker)) {
         workerSetElt = workerSetElement;
       }