Merge dependabot/npm_and_yarn/examples/typescript/http-server-pool/fastify-worker_thr...

[poolifier.git] / src / worker / worker-options.ts

diff --git a/src/worker/worker-options.ts b/src/worker/worker-options.ts
index f829dcb3f25078aa6c1845c4fd367cc35129769e..b2efb7acbce451a5d0ec663e357f5104ec243c6e 100644 (file)
--- 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,6 +50,12 @@ export interface WorkerOptions {
    * @defaultValue 60000
    */
   maxInactiveTime?: number
+  /**
+   * The function to call when a worker is killed.
+   *
+   * @defaultValue `() => {}`
+   */
+  killHandler?: KillHandler
   /**
    * Whether your worker will perform asynchronous or not.
    *
@@ -46,19 +63,4 @@ export interface WorkerOptions {
    * @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.
-   */
-  killHandler?: KillHandler
 }