docs: add changelog entry

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

diff --git a/src/worker/worker-options.ts b/src/worker/worker-options.ts
index 384b2a1104498520719c220aa9300398faf1d2bd..50cf85bb03910a03fdd25f9e479e2b03dea45270 100644 (file)
--- 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.
@@ -29,8 +30,8 @@ export interface WorkerOptions {
   /**
    * `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.
+   * - 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.
    *
@@ -38,7 +39,7 @@ export interface WorkerOptions {
    */
   killBehavior?: KillBehavior
   /**
-   * Maximum waiting time in milliseconds for tasks on newly created workers.
+   * 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.
@@ -52,13 +53,8 @@ export interface WorkerOptions {
   maxInactiveTime?: number
   /**
    * The function to call when a worker is killed.
-   */
-  killHandler?: KillHandler
-  /**
-   * Whether your worker will perform asynchronous or not.
    *
-   * @defaultValue false
-   * @deprecated This option will be removed in the next major version.
+   * @defaultValue `() => {}`
    */
-  async?: boolean
+  killHandler?: KillHandler
 }