feat: remove Node.js 16.x support

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

diff --git a/src/worker/worker-options.ts b/src/worker/worker-options.ts
index e6137c7fc659b6e989f510cab0f090a2058b01d3..a6af1ec076916ec74fc1d69164aede194e189498 100644 (file)
--- a/src/worker/worker-options.ts
+++ b/src/worker/worker-options.ts
@@ -17,12 +17,28 @@ export const KillBehaviors = Object.freeze({
  */
 export type KillBehavior = keyof typeof KillBehaviors
 
+/**
+ * Handler called when a worker is killed.
+ */
+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 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.
@@ -35,21 +51,9 @@ export interface WorkerOptions {
    */
   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.
+   * The function to call when a worker is killed.
    *
-   * @defaultValue KillBehaviors.SOFT
+   * @defaultValue `() => {}`
    */
-  killBehavior?: KillBehavior
+  killHandler?: KillHandler
 }