feat: remove Node.js 16.x support

[poolifier.git] / src / worker / worker-options.ts

diff --git a/src/worker/worker-options.ts b/src/worker/worker-options.ts
index 55f3a074b769e8de6733deb667c43a6ca51b2328..a6af1ec076916ec74fc1d69164aede194e189498 100644 (file)
--- a/src/worker/worker-options.ts
+++ b/src/worker/worker-options.ts
@@ -3,11 +3,11 @@
  */
 export const KillBehaviors = Object.freeze({
   /**
-   * If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still running, then the worker **wont** be deleted.
+   * If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still executing or queued, then the worker **wont** be deleted.
    */
   SOFT: 'SOFT',
   /**
-   * If `lastActiveTime` is greater than `maxInactiveTime` but a task is still running, then the worker will be deleted.
+   * If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still executing or queued, then the worker will be deleted.
    */
   HARD: 'HARD'
 } as const)
@@ -18,52 +18,42 @@ export const KillBehaviors = Object.freeze({
 export type KillBehavior = keyof typeof KillBehaviors
 
 /**
- * Detects whether the given value is a kill behavior or not.
- *
- * @template KB Which specific KillBehavior to test against.
- * @param killBehavior Which kind of kill behavior to detect.
- * @param value Any value.
- * @returns `true` if `value` was strictly equals to `killBehavior`, otherwise `false`.
+ * Handler called when a worker is killed.
  */
-export function isKillBehavior<KB extends KillBehavior> (
-  killBehavior: KB,
-  value: unknown
-): value is KB {
-  return value === killBehavior
-}
+export type KillHandler = () => void | Promise<void>
 
 /**
  * Options for workers.
  */
 export interface WorkerOptions {
   /**
-   * Maximum waiting time in milliseconds for tasks.
+   * `killBehavior` dictates if your worker will be deleted in case a task is active on it.
+   *
+   * - SOFT: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still executing or queued, then the worker **won't** be deleted.
+   * - HARD: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still executing or queued, then the worker will be deleted.
+   *
+   * This option only apply to the newly created workers.
+   *
+   * @defaultValue KillBehaviors.SOFT
+   */
+  killBehavior?: KillBehavior
+  /**
+   * Maximum waiting time in milliseconds for tasks on newly created workers. It must be greater or equal than 5.
    *
    * After this time, newly created workers will be terminated.
-   * The last active time of your worker unit will be updated when a task is submitted to a worker or when a worker terminate a task.
+   * The last active time of your worker will be updated when it terminates a task.
    *
    * - If `killBehavior` is set to `KillBehaviors.HARD` this value represents also the timeout for the tasks that you submit to the pool,
-   *   when this timeout expires your tasks is interrupted and the worker is killed if is not part of the minimum size of the pool.
+   *   when this timeout expires your tasks is interrupted before completion and removed. The worker is killed if is not part of the minimum size of the pool.
    * - If `killBehavior` is set to `KillBehaviors.SOFT` your tasks have no timeout and your workers will not be terminated until your task is completed.
    *
-   * @default 60.000 ms
+   * @defaultValue 60000
    */
   maxInactiveTime?: number
   /**
-   * Whether your worker will perform asynchronous or not.
+   * The function to call when a worker is killed.
    *
-   * @default false
+   * @defaultValue `() => {}`
    */
-  async?: boolean
-  /**
-   * `killBehavior` dictates if your async unit (worker/process) will be deleted in case that a task is active on it.
-   *
-   * - SOFT: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still running, then the worker **wont** be deleted.
-   * - HARD: If `lastActiveTime` is greater than `maxInactiveTime` but a task is still running, then the worker will be deleted.
-   *
-   * This option only apply to the newly created workers.
-   *
-   * @default KillBehaviors.SOFT
-   */
-  killBehavior?: KillBehavior
+  killHandler?: KillHandler
 }