Improve a bit JSDoc.

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

diff --git a/src/worker/WorkerDynamicPool.ts b/src/worker/WorkerDynamicPool.ts
index 570e5d1bcb2bded02486202787a876d32f251d88..a9aa56f09765912a3a4193bb8acc299654d1d3a2 100644 (file)
--- a/src/worker/WorkerDynamicPool.ts
+++ b/src/worker/WorkerDynamicPool.ts
@@ -1,17 +1,20 @@
-import { DynamicThreadPool, DynamicThreadPoolOptions } from 'poolifier';
+import { DynamicThreadPool, PoolOptions } from 'poolifier';
 
 import Constants from '../utils/Constants';
 import Utils from '../utils/Utils';
+import { Worker } from 'worker_threads';
+import WorkerAbstract from './WorkerAbstract';
 import { WorkerData } from '../types/Worker';
-import Wrk from './Wrk';
 
-export default class WorkerDynamicPool extends Wrk {
+export default class WorkerDynamicPool<T> extends WorkerAbstract {
   private pool: DynamicPool;
 
   /**
    * Create a new `WorkerDynamicPool`.
    *
    * @param {string} workerScript
+   * @param {number} min
+   * @param {number} max
    */
   constructor(workerScript: string, min: number, max: number,) {
     super(workerScript);
@@ -23,12 +26,12 @@ export default class WorkerDynamicPool extends Wrk {
   }
 
   get maxElementsPerWorker(): number {
-    return 1;
+    return null;
   }
 
   /**
    *
-   * @return {Promise<void>}
+   * @returns {Promise<void>}
    * @public
    */
   // eslint-disable-next-line @typescript-eslint/no-empty-function
@@ -36,10 +39,21 @@ export default class WorkerDynamicPool extends Wrk {
 
   /**
    *
-   * @return {Promise<void>}
+   * @returns {Promise<void>}
    * @public
    */
-  public async addElement(elementData: WorkerData): Promise<void> {
+  // eslint-disable-next-line @typescript-eslint/require-await
+  public async stop(): Promise<void> {
+    return this.pool.destroy();
+  }
+
+  /**
+   *
+   * @param elementData
+   * @returns {Promise<void>}
+   * @public
+   */
+  public async addElement(elementData: T): Promise<void> {
     await this.pool.execute(elementData);
     // Start worker sequentially to optimize memory at startup
     await Utils.sleep(Constants.START_WORKER_DELAY);
@@ -49,13 +63,13 @@ export default class WorkerDynamicPool extends Wrk {
 class DynamicPool extends DynamicThreadPool<WorkerData> {
   private static instance: DynamicPool;
 
-  private constructor(min: number, max: number, filename: string, opts?: DynamicThreadPoolOptions) {
-    super(min, max, filename, opts);
+  private constructor(min: number, max: number, workerScript: string, opts?: PoolOptions<Worker>) {
+    super(min, max, workerScript, opts);
   }
 
-  public static getInstance(min: number, max: number, filename: string): DynamicPool {
+  public static getInstance(min: number, max: number, workerScript: string): DynamicPool {
     if (!DynamicPool.instance) {
-      DynamicPool.instance = new DynamicPool(min, max, filename,
+      DynamicPool.instance = new DynamicPool(min, max, workerScript,
         {
           exitHandler: (code) => {
             if (code !== 0) {