X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fworker-options.ts;h=e6137c7fc659b6e989f510cab0f090a2058b01d3;hb=b0a4db63f53f4df5d60abc592f32043468626574;hp=791f915d580a32c822d91148db7d91f7dbf82912;hpb=70c7d7d3af9c38417416ca9096a6ab3ae835b5d0;p=poolifier.git

diff --git a/src/worker/worker-options.ts b/src/worker/worker-options.ts
index 791f915d..e6137c7f 100644
--- 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 `currentTime - 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)
@@ -17,33 +17,18 @@ export const KillBehaviors = Object.freeze({
  */
 export type KillBehavior = keyof typeof KillBehaviors
 
-/**
- * Detects whether the given value is a kill behavior or not.
- *
- * @typeParam KB - Which specific KillBehavior type 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`.
- */
-export function isKillBehavior<KB extends KillBehavior> (
-  killBehavior: KB,
-  value: unknown
-): value is KB {
-  return value === killBehavior
-}
-
 /**
  * Options for workers.
  */
 export interface WorkerOptions {
   /**
-   * Maximum waiting time in milliseconds for tasks.
+   * 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 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.
    *
    * @defaultValue 60000
@@ -57,10 +42,10 @@ export interface WorkerOptions {
    */
   async?: boolean
   /**
-   * `killBehavior` dictates if your async unit (worker/process) will be deleted in case that a task is active on it.
+   * `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 running, then the worker **won't** be deleted.
-   * - HARD: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still running, then the worker will be deleted.
+   * - 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.
    *