X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fworker-options.ts;h=a6af1ec076916ec74fc1d69164aede194e189498;hb=b1bbc3658b183a5c7a10c76daa4a775b64bf15ee;hp=f829dcb3f25078aa6c1845c4fd367cc35129769e;hpb=07588f306649b9df235aaf65de4842e99532ed6a;p=poolifier.git

diff --git a/src/worker/worker-options.ts b/src/worker/worker-options.ts
index f829dcb3..a6af1ec0 100644
--- a/src/worker/worker-options.ts
+++ b/src/worker/worker-options.ts
@@ -27,7 +27,18 @@ export type KillHandler = () => void | Promise<void>
  */
 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 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.
@@ -39,26 +50,10 @@ export interface WorkerOptions {
    * @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
 }