X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fworker-options.ts;h=92761840efda547c43a0c9758231c0c1d1b84bab;hb=refs%2Fheads%2Fmaster;hp=97d4a30a59ed3d47503d59fe55eae393f8e52e9f;hpb=df9aaf207bf2e96ed759f9b89fa6573e8c48fb65;p=poolifier.git

diff --git a/src/worker/worker-options.ts b/src/worker/worker-options.ts
index 97d4a30a..92761840 100644
--- a/src/worker/worker-options.ts
+++ b/src/worker/worker-options.ts
@@ -1,16 +1,17 @@
 /**
  * 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)
+export const KillBehaviors: Readonly<{ SOFT: 'SOFT'; HARD: 'HARD' }> =
+  Object.freeze({
+    /**
+     * If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but the worker is stealing tasks or a task is executing or queued, then the worker **wont** be deleted.
+     */
+    SOFT: 'SOFT',
+    /**
+     * If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but the worker is stealing tasks or a task is executing or queued, then the worker will be deleted.
+     */
+    HARD: 'HARD',
+  } as const)
 
 /**
  * Kill behavior.
@@ -20,45 +21,37 @@ export type KillBehavior = keyof typeof KillBehaviors
 /**
  * Handler called when a worker is killed.
  */
-export type KillHandler = () => void
+export type KillHandler = () => void | Promise<void>
 
 /**
  * Options for workers.
  */
 export interface WorkerOptions {
   /**
-   * Maximum waiting time in milliseconds for tasks on newly created workers.
+   * `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 the worker is stealing tasks or a task is executing or queued, then the worker **won't** be deleted.
+   * - HARD: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but the worker is stealing tasks or a task is 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.
+   * 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
-  /**
-   * Whether your worker will perform asynchronous or not.
-   *
-   * @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
   /**
    * The function to call when a worker is killed.
+   * @defaultValue `() => {}`
    */
   killHandler?: KillHandler
 }