X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fworker-options.ts;h=e6137c7fc659b6e989f510cab0f090a2058b01d3;hb=3d76750ac8dacd95003ca89cf9542c3b2a014b8c;hp=75d3dd5b98bf1d8e633d3b58c0190cd3c1f20f93;hpb=5931725336d0de8a06146641ae6feef22bf60e6e;p=poolifier.git diff --git a/src/worker/worker-options.ts b/src/worker/worker-options.ts index 75d3dd5b..e6137c7f 100644 --- a/src/worker/worker-options.ts +++ b/src/worker/worker-options.ts @@ -22,13 +22,13 @@ export type KillBehavior = keyof typeof KillBehaviors */ export interface WorkerOptions { /** - * Maximum waiting time in milliseconds for tasks. + * Maximum waiting time in milliseconds for tasks on newly created workers. * * 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. + * The last active time of your worker will be updated when it terminates a task. * * - If `killBehavior` is set to `KillBehaviors.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 before completion and removed. The worker is killed if is not part of the minimum size of the pool. * - If `killBehavior` is set to `KillBehaviors.SOFT` your tasks have no timeout and your workers will not be terminated until your task is completed. * * @defaultValue 60000 @@ -42,7 +42,7 @@ 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 worker will be deleted in case a task is active on it. * * - SOFT: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still executing or queued, then the worker **won't** be deleted. * - HARD: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still executing or queued, then the worker will be deleted.