2 * Enumeration of kill behaviors.
4 export const KillBehaviors
: Readonly
<{ SOFT
: 'SOFT'; HARD
: 'HARD' }> =
7 * If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but the worker is stealing tasks or a task is executing or queued, then the worker **wont** be deleted.
11 * If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but the worker is stealing tasks or a task is executing or queued, then the worker will be deleted.
19 export type KillBehavior
= keyof
typeof KillBehaviors
22 * Handler called when a worker is killed.
24 export type KillHandler
= () => void | Promise
<void>
27 * Options for workers.
29 export interface WorkerOptions
{
31 * `killBehavior` dictates if your worker will be deleted in case a task is active on it.
33 * - SOFT: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but the worker is stealing tasks or a task is executing or queued, then the worker **won't** be deleted.
34 * - HARD: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but the worker is stealing tasks or a task is executing or queued, then the worker will be deleted.
36 * This option only apply to the newly created workers.
37 * @defaultValue KillBehaviors.SOFT
39 killBehavior
?: KillBehavior
41 * Maximum waiting time in milliseconds for tasks on newly created workers. It must be greater or equal than 5.
43 * After this time, newly created workers will be terminated.
44 * The last active time of your worker will be updated when it terminates a task.
46 * - If `killBehavior` is set to `KillBehaviors.HARD` this value represents also the timeout for the tasks that you submit to the pool,
47 * 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.
48 * - If `killBehavior` is set to `KillBehaviors.SOFT` your tasks have no timeout and your workers will not be terminated until your task is completed.
51 maxInactiveTime
?: number
53 * The function to call when a worker is killed.
54 * @defaultValue `() => {}`
56 killHandler
?: KillHandler