Update src/worker/worker-options.ts
[poolifier.git] / src / worker / worker-options.ts
index 68aa71e6f53b080c0e93452b4b3646e3293aea87..4e38c296bd15d4569687ff28d1f501e1d320db3e 100644 (file)
@@ -15,7 +15,7 @@ export interface WorkerOptions {
    * 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.
+   * 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.
    *
    * @default 60.000 ms
@@ -35,5 +35,5 @@ export interface WorkerOptions {
    *
    * @default SOFT
    */
-  killBehavior?: string
+  killBehavior?: 'HARD' | 'SOFT'
 }