X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fworker-options.ts;h=c9a3cdfa6f43c9828f3bb3e60d6ab7e4acc0f757;hb=8accb8d5d2f8a6d77017a421938796623ac2b239;hp=4473a97533b5c07db172d1c756ae0bce47d1d03a;hpb=aad2595fd9c26bcb2f0d7a22d06edf56d5b08bdb;p=poolifier.git diff --git a/src/worker/worker-options.ts b/src/worker/worker-options.ts index 4473a975..c9a3cdfa 100644 --- a/src/worker/worker-options.ts +++ b/src/worker/worker-options.ts @@ -21,7 +21,7 @@ export type KillBehavior = keyof typeof KillBehaviors * Detects whether the given value is a kill behavior or not. * * @template KB Which specific KillBehavior to test against. - * @param killBehavior Which kind of kill behavior to detect. Default: `KillBehaviors.HARD`. + * @param killBehavior Which kind of kill behavior to detect. * @param value Any value. * @returns `true` if `value` was strictly equals to `killBehavior`, otherwise `false`. */ @@ -44,9 +44,9 @@ export interface WorkerOptions { * * - 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. - * - If `killBehavior` is set to `KillBehaviors.SOFT` your tasks have no timeout and your workers will not be terminated until your task is. + * - If `killBehavior` is set to `KillBehaviors.SOFT` your tasks have no timeout and your workers will not be terminated until your task is completed. * - * @default 60.000 ms + * @default 60000 ms */ maxInactiveTime?: number /** @@ -58,7 +58,7 @@ export interface WorkerOptions { /** * `killBehavior` dictates if your async unit (worker/process) will be deleted in case that a task is active on it. * - * - SOFT: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still running, then the worker **wont** be deleted. + * - SOFT: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still running, then the worker **won't** be deleted. * - HARD: If `lastActiveTime` is greater than `maxInactiveTime` but a task is still running, then the worker will be deleted. * * This option only apply to the newly created workers.