refactor: refine worker options scope
authorJérôme Benoit <jerome.benoit@sap.com>
Fri, 7 Apr 2023 14:25:20 +0000 (16:25 +0200)
committerJérôme Benoit <jerome.benoit@sap.com>
Fri, 7 Apr 2023 14:25:20 +0000 (16:25 +0200)
Signed-off-by: Jérôme Benoit <jerome.benoit@sap.com>
src/pools/abstract-pool.ts
src/pools/pool-internal.ts
src/worker/abstract-worker.ts

index 68e833710f802d7bd30f52bab9955dc373072c35..97225246cde2e8baab84cd2a60968ca7d09aa079 100644 (file)
@@ -248,11 +248,12 @@ export abstract class AbstractPool<
   /**
    * Setup hook that can be overridden by a Poolifier pool implementation
    * to run code before workers are created in the abstract constructor.
+   * Can be overridden
    *
    * @virtual
    */
   protected setupHook (): void {
-    // Can be overridden
+    // Intentionally empty
   }
 
   /**
index 095e954e2c2bb498ad27f1e1a5999686b99249a7..ddfcc41ec40758e8520a2d708bf823aaaebeb39c 100644 (file)
@@ -3,6 +3,8 @@ import type { IPoolWorker } from './pool-worker'
 
 /**
  * Internal pool types.
+ *
+ * @enum
  */
 export enum PoolType {
   FIXED = 'fixed',
index 5165417924b66cafbb9dceb6e2cab53c24ee7965..475595eccf5f2e2c85b4eac8ba251f306f472c5d 100644 (file)
@@ -29,10 +29,6 @@ export abstract class AbstractWorker<
    * Handler Id of the `aliveInterval` worker alive check.
    */
   protected readonly aliveInterval?: NodeJS.Timeout
-  /**
-   * Options for the worker.
-   */
-  public readonly opts: WorkerOptions
   /**
    * Constructs a new poolifier worker.
    *
@@ -47,7 +43,7 @@ export abstract class AbstractWorker<
     protected readonly isMain: boolean,
     fn: (data: Data) => Response,
     protected mainWorker: MainWorker | undefined | null,
-    opts: WorkerOptions = {
+    protected readonly opts: WorkerOptions = {
       /**
        * The kill behavior option on this Worker or its default value.
        */
@@ -60,7 +56,6 @@ export abstract class AbstractWorker<
     }
   ) {
     super(type)
-    this.opts = opts
     this.checkFunctionInput(fn)
     this.checkWorkerOptions(this.opts)
     if (!this.isMain) {