Merge pull request #884 from poolifier/dependabot/npm_and_yarn/examples/typescript...
[poolifier.git] / src / worker / abstract-worker.ts
index 44c392bcf75aba937a694b7dab43f72e07cc7a34..75a8d784f87d4cd18126d2f81ce9ba54fae65323 100644 (file)
@@ -14,11 +14,7 @@ import {
   isAsyncFunction,
   isPlainObject
 } from '../utils'
-import {
-  type KillBehavior,
-  KillBehaviors,
-  type WorkerOptions
-} from './worker-options'
+import { KillBehaviors, type WorkerOptions } from './worker-options'
 import type {
   TaskAsyncFunction,
   TaskFunction,
@@ -27,7 +23,21 @@ import type {
 } from './task-functions'
 
 const DEFAULT_MAX_INACTIVE_TIME = 60000
-const DEFAULT_KILL_BEHAVIOR: KillBehavior = KillBehaviors.SOFT
+const DEFAULT_WORKER_OPTIONS: WorkerOptions = {
+  /**
+   * The kill behavior option on this worker or its default value.
+   */
+  killBehavior: KillBehaviors.SOFT,
+  /**
+   * The maximum time to keep this worker active while idle.
+   * The pool automatically checks and terminates this worker when the time expires.
+   */
+  maxInactiveTime: DEFAULT_MAX_INACTIVE_TIME,
+  /**
+   * The function to call when the worker is killed.
+   */
+  killHandler: EMPTY_FUNCTION
+}
 
 /**
  * Base class that implements some shared logic for all poolifier workers.
@@ -75,21 +85,7 @@ export abstract class AbstractWorker<
     protected readonly isMain: boolean,
     private readonly mainWorker: MainWorker,
     taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>,
-    protected readonly opts: WorkerOptions = {
-      /**
-       * The kill behavior option on this worker or its default value.
-       */
-      killBehavior: DEFAULT_KILL_BEHAVIOR,
-      /**
-       * The maximum time to keep this worker active while idle.
-       * The pool automatically checks and terminates this worker when the time expires.
-       */
-      maxInactiveTime: DEFAULT_MAX_INACTIVE_TIME,
-      /**
-       * The function to call when the worker is killed.
-       */
-      killHandler: EMPTY_FUNCTION
-    }
+    protected opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
   ) {
     super(type)
     this.checkWorkerOptions(this.opts)
@@ -100,10 +96,7 @@ export abstract class AbstractWorker<
   }
 
   private checkWorkerOptions (opts: WorkerOptions): void {
-    this.opts.killBehavior = opts.killBehavior ?? DEFAULT_KILL_BEHAVIOR
-    this.opts.maxInactiveTime =
-      opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME
-    this.opts.killHandler = opts.killHandler ?? EMPTY_FUNCTION
+    this.opts = { ...DEFAULT_WORKER_OPTIONS, ...opts }
     delete this.opts.async
   }
 
@@ -172,12 +165,7 @@ export abstract class AbstractWorker<
    * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string or an empty string.
    */
   public hasTaskFunction (name: string): boolean {
-    if (typeof name !== 'string') {
-      throw new TypeError('name parameter is not a string')
-    }
-    if (typeof name === 'string' && name.trim().length === 0) {
-      throw new TypeError('name parameter is an empty string')
-    }
+    this.checkTaskFunctionName(name)
     return this.taskFunctions.has(name)
   }
 
@@ -196,12 +184,7 @@ export abstract class AbstractWorker<
     name: string,
     fn: TaskFunction<Data, Response>
   ): boolean {
-    if (typeof name !== 'string') {
-      throw new TypeError('name parameter is not a string')
-    }
-    if (typeof name === 'string' && name.trim().length === 0) {
-      throw new TypeError('name parameter is an empty string')
-    }
+    this.checkTaskFunctionName(name)
     if (name === DEFAULT_TASK_NAME) {
       throw new Error(
         'Cannot add a task function with the default reserved name'
@@ -236,12 +219,7 @@ export abstract class AbstractWorker<
    * @throws {@link https://nodejs.org/api/errors.html#class-error} If the `name` parameter is the task function used as default task function.
    */
   public removeTaskFunction (name: string): boolean {
-    if (typeof name !== 'string') {
-      throw new TypeError('name parameter is not a string')
-    }
-    if (typeof name === 'string' && name.trim().length === 0) {
-      throw new TypeError('name parameter is an empty string')
-    }
+    this.checkTaskFunctionName(name)
     if (name === DEFAULT_TASK_NAME) {
       throw new Error(
         'Cannot remove the task function with the default reserved name'
@@ -295,12 +273,7 @@ export abstract class AbstractWorker<
    * @throws {@link https://nodejs.org/api/errors.html#class-error} If the `name` parameter is a non-existing task function.
    */
   public setDefaultTaskFunction (name: string): boolean {
-    if (typeof name !== 'string') {
-      throw new TypeError('name parameter is not a string')
-    }
-    if (typeof name === 'string' && name.trim().length === 0) {
-      throw new TypeError('name parameter is an empty string')
-    }
+    this.checkTaskFunctionName(name)
     if (name === DEFAULT_TASK_NAME) {
       throw new Error(
         'Cannot set the default task function reserved name as the default task function'
@@ -322,6 +295,15 @@ export abstract class AbstractWorker<
     }
   }
 
+  private checkTaskFunctionName (name: string): void {
+    if (typeof name !== 'string') {
+      throw new TypeError('name parameter is not a string')
+    }
+    if (typeof name === 'string' && name.trim().length === 0) {
+      throw new TypeError('name parameter is an empty string')
+    }
+  }
+
   /**
    * Handles the ready message sent by the main worker.
    *