X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fworker-options.ts;h=7f9c650694b83c5c1675aa0291f2b312711be522;hb=27a8a097ad47621d1a914240d777921f129cff61;hp=86129901553e80771ce9744c9eda2bd149678520;hpb=325f50bc1777ea44abc9736ce9d780ec0c8f90e2;p=poolifier.git

diff --git a/src/worker/worker-options.ts b/src/worker/worker-options.ts
index 86129901..7f9c6506 100644
--- a/src/worker/worker-options.ts
+++ b/src/worker/worker-options.ts
@@ -1,14 +1,60 @@
+/**
+ * Enumeration of kill behaviors.
+ */
+export const KillBehaviors: Readonly<{ SOFT: 'SOFT', HARD: 'HARD' }> =
+  Object.freeze({
+    /**
+     * If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still executing or queued, then the worker **wont** be deleted.
+     */
+    SOFT: 'SOFT',
+    /**
+     * 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)
+
+/**
+ * Kill behavior.
+ */
+export type KillBehavior = keyof typeof KillBehaviors
+
+/**
+ * Handler called when a worker is killed.
+ */
+export type KillHandler = () => void | Promise<void>
+
+/**
+ * Options for workers.
+ */
 export interface WorkerOptions {
   /**
-   * Max time to wait tasks to work on (in ms), after this period the new worker threads will die.
+   * `killBehavior` dictates if your worker will be deleted in case a task is active on it.
    *
-   * @default 60.000 ms
+   * - 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 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 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.
+   *
+   * @defaultValue 60000
    */
   maxInactiveTime?: number
   /**
-   * `true` if your function contains async pieces, else `false`.
+   * The function to call when a worker is killed.
    *
-   * @default false
+   * @defaultValue `() => {}`
    */
-  async?: boolean
+  killHandler?: KillHandler
 }