X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fworker-options.ts;h=b1d13d0cd37fd4471a3d882ed98e191a9e626a76;hb=fb41d7f7735b2e2b13874c11aeb55829f79f292f;hp=68aa71e6f53b080c0e93452b4b3646e3293aea87;hpb=a60fa7710248e2a7e30aa3a33852570fc0ad6dec;p=poolifier.git diff --git a/src/worker/worker-options.ts b/src/worker/worker-options.ts index 68aa71e6..b1d13d0c 100644 --- a/src/worker/worker-options.ts +++ b/src/worker/worker-options.ts @@ -1,3 +1,5 @@ +import type { KillBehavior } from '../utility-types' + /** * Kill behavior enumeration */ @@ -14,9 +16,9 @@ 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, + * 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 */ @@ -29,11 +31,11 @@ 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. - * 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. + * 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?: string + killBehavior?: KillBehavior }