build: build fix package publishing on JSR

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

diff --git a/src/worker/worker-options.ts b/src/worker/worker-options.ts
index 3f1946d256a2732e3b9e36ce00d8c7acd5ee394d..7f9c650694b83c5c1675aa0291f2b312711be522 100644 (file)
--- a/src/worker/worker-options.ts
+++ b/src/worker/worker-options.ts
@@ -1,39 +1,60 @@
 /**
- * Kill behavior enumeration
+ * Enumeration of kill behaviors.
  */
-export const killBehaviorEnumeration = Object.freeze({
-  SOFT: 'SOFT',
-  HARD: 'HARD'
-})
+export const KillBehaviors: Readonly<{ SOFT: 'SOFT', HARD: 'HARD' }> =
+  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)
+
+/**
+ * Kill behavior.
+ */
+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.
-   * After this time, newly created workers will be terminated.
-   * The last active time of your worker unit will be updated when a task is submitted to a worker or when a worker terminate a task.
-   * If `killBehavior` is set to `HARD` this value represents also the timeout for the tasks that you submit to the pool,
-   * when this timeout expires your tasks is interrupted and the worker is killed if it is not part of the minimum size of the pool.
-   * If `killBehavior` is set to `SOFT` your tasks have no timeout and your workers will not be terminated until your task is finished.
+   * `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.
    *
-   * @default 60.000 ms
+   * This option only apply to the newly created workers.
+   *
+   * @defaultValue KillBehaviors.SOFT
    */
-  maxInactiveTime?: number
+  killBehavior?: KillBehavior
   /**
-   * Whether your worker will perform asynchronous or not.
+   * 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.
+   * - If `killBehavior` is set to `KillBehaviors.SOFT` your tasks have no timeout and your workers will not be terminated until your task is completed.
    *
-   * @default false
+   * @defaultValue 60000
    */
-  async?: boolean
+  maxInactiveTime?: number
   /**
-   * `killBehavior` dictates if your async unit (worker/process) will be deleted in case that a task is active on it.
-   * SOFT: If current time - last active time is greater than `maxInactiveTime` option, but a task is still running then the worker will be not deleted.
-   * HARD: If last active time is greater than `maxInactiveTime` option, but a task is still running then the worker will be deleted.
-   * This option only apply to the newly created workers.
+   * The function to call when a worker is killed.
    *
-   * @default `'SOFT'`
+   * @defaultValue `() => {}`
    */
-  killBehavior?: 'HARD' | 'SOFT'
+  killHandler?: KillHandler
 }