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

diff --git a/src/worker/worker-options.ts b/src/worker/worker-options.ts
index 86129901..e6137c7f 100644
--- a/src/worker/worker-options.ts
+++ b/src/worker/worker-options.ts
@@ -1,14 +1,55 @@
+/**
+ * Enumeration of kill behaviors.
+ */
+export const KillBehaviors = 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
+
+/**
+ * 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.
+   * Maximum waiting time in milliseconds for tasks on newly created workers.
+   *
+   * 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.
    *
-   * @default 60.000 ms
+   * @defaultValue 60000
    */
   maxInactiveTime?: number
   /**
-   * `true` if your function contains async pieces, else `false`.
+   * Whether your worker will perform asynchronous or not.
    *
-   * @default false
+   * @defaultValue false
+   * @deprecated This option will be removed in the next major version.
    */
   async?: boolean
+  /**
+   * `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
 }