TODO for shinigami

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

diff --git a/src/worker/worker-options.ts b/src/worker/worker-options.ts
index 86129901553e80771ce9744c9eda2bd149678520..b1d13d0cd37fd4471a3d882ed98e191a9e626a76 100644 (file)
--- a/src/worker/worker-options.ts
+++ b/src/worker/worker-options.ts
@@ -1,14 +1,41 @@
+import type { KillBehavior } from '../utility-types'
+
+/**
+ * Kill behavior enumeration
+ */
+export const killBehaviorEnumeration = Object.freeze({
+  SOFT: 'SOFT',
+  HARD: 'HARD'
+})
+
+/**
+ * Options for workers.
+ */
 export interface WorkerOptions {
   /**
-   * Max time to wait tasks to work on (in ms), after this period the new worker threads will die.
+   * 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 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
    *
    * @default 60.000 ms
    */
   maxInactiveTime?: number
   /**
-   * `true` if your function contains async pieces, else `false`.
+   * Whether your worker will perform asynchronous or not.
    *
    * @default false
    */
   async?: boolean
+  /**
+   * 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.
+   *
+   * @default SOFT
+   */
+  killBehavior?: KillBehavior
 }