TODO for shinigami
[poolifier.git] / src / worker / worker-options.ts
index 8bb9cc50879e8c04e7bf6d2f8e56a856c36ab2fc..b1d13d0cd37fd4471a3d882ed98e191a9e626a76 100644 (file)
@@ -1,3 +1,5 @@
+import type { KillBehavior } from '../utility-types'
+
 /**
  * Kill behavior enumeration
  */
@@ -16,7 +18,7 @@ export interface WorkerOptions {
    * 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 finished.
+   * 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
    */
@@ -35,5 +37,5 @@ export interface WorkerOptions {
    *
    * @default SOFT
    */
-  killBehavior?: string
+  killBehavior?: KillBehavior
 }