X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fworker-options.ts;h=791f915d580a32c822d91148db7d91f7dbf82912;hb=e34f0ebcd2536e0890242ab414467c0e68ed65e6;hp=4e5a3d07d99c372b5d24854471d6b97f9c297566;hpb=a9d9ea34ae4621d0babc235b10614c7c8c37d88b;p=poolifier.git diff --git a/src/worker/worker-options.ts b/src/worker/worker-options.ts index 4e5a3d07..791f915d 100644 --- a/src/worker/worker-options.ts +++ b/src/worker/worker-options.ts @@ -20,7 +20,7 @@ export type KillBehavior = keyof typeof KillBehaviors /** * Detects whether the given value is a kill behavior or not. * - * @typeParam KB - Which specific KillBehavior to test against. + * @typeParam KB - Which specific KillBehavior type to test against. * @param killBehavior - Which kind of kill behavior to detect. * @param value - Any value. * @returns `true` if `value` was strictly equals to `killBehavior`, otherwise `false`. @@ -46,13 +46,14 @@ export interface WorkerOptions { * 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 completed. * - * @defaultValue 60000 ms + * @defaultValue 60000 */ maxInactiveTime?: number /** * Whether your worker will perform asynchronous or not. * * @defaultValue false + * @deprecated This option will be removed in the next major version. */ async?: boolean /**