2 * Enumeration of kill behaviors.
4 export const KillBehaviors
= Object.freeze({
6 * If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still executing or queued, then the worker **wont** be deleted.
10 * If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still executing or queued, then the worker will be deleted.
18 export type KillBehavior
= keyof
typeof KillBehaviors
21 * Handler called when a worker is killed.
23 export type KillHandler
= () => void | Promise
<void>
26 * Options for workers.
28 export interface WorkerOptions
{
30 * Maximum waiting time in milliseconds for tasks on newly created workers.
32 * After this time, newly created workers will be terminated.
33 * The last active time of your worker will be updated when it terminates a task.
35 * - If `killBehavior` is set to `KillBehaviors.HARD` this value represents also the timeout for the tasks that you submit to the pool,
36 * 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.
37 * - If `killBehavior` is set to `KillBehaviors.SOFT` your tasks have no timeout and your workers will not be terminated until your task is completed.
41 maxInactiveTime
?: number
43 * Whether your worker will perform asynchronous or not.
46 * @deprecated This option will be removed in the next major version.
50 * `killBehavior` dictates if your worker will be deleted in case a task is active on it.
52 * - SOFT: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still executing or queued, then the worker **won't** be deleted.
53 * - HARD: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still executing or queued, then the worker will be deleted.
55 * This option only apply to the newly created workers.
57 * @defaultValue KillBehaviors.SOFT
59 killBehavior
?: KillBehavior
61 * The function to call when a worker is killed.
63 killHandler
?: KillHandler