X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fworker-options.ts;h=3f1946d256a2732e3b9e36ce00d8c7acd5ee394d;hb=0eb5d0500f1463740dd293085d9243b1b795f109;hp=68aa71e6f53b080c0e93452b4b3646e3293aea87;hpb=a60fa7710248e2a7e30aa3a33852570fc0ad6dec;p=poolifier.git diff --git a/src/worker/worker-options.ts b/src/worker/worker-options.ts index 68aa71e6..3f1946d2 100644 --- a/src/worker/worker-options.ts +++ b/src/worker/worker-options.ts @@ -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 @@ -28,12 +28,12 @@ export interface WorkerOptions { */ async?: boolean /** - * killBehavior dictates if your async unit ( worker/process ) will be deleted in case that a task is active on it. + * `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 + * @default `'SOFT'` */ - killBehavior?: string + killBehavior?: 'HARD' | 'SOFT' }