---
[poolifier.git] / src / worker / worker-options.ts
1 /**
2 * Enumeration of kill behaviors.
3 */
4 export const KillBehaviors: Readonly<{ SOFT: 'SOFT', HARD: 'HARD' }> =
5 Object.freeze({
6 /**
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.
8 */
9 SOFT: 'SOFT',
10 /**
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.
12 */
13 HARD: 'HARD'
14 } as const)
15
16 /**
17 * Kill behavior.
18 */
19 export type KillBehavior = keyof typeof KillBehaviors
20
21 /**
22 * Handler called when a worker is killed.
23 */
24 export type KillHandler = () => void | Promise<void>
25
26 /**
27 * Options for workers.
28 */
29 export interface WorkerOptions {
30 /**
31 * `killBehavior` dictates if your worker will be deleted in case a task is active on it.
32 *
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.
35 *
36 * This option only apply to the newly created workers.
37 *
38 * @defaultValue KillBehaviors.SOFT
39 */
40 killBehavior?: KillBehavior
41 /**
42 * Maximum waiting time in milliseconds for tasks on newly created workers. It must be greater or equal than 5.
43 *
44 * After this time, newly created workers will be terminated.
45 * The last active time of your worker will be updated when it terminates a task.
46 *
47 * - If `killBehavior` is set to `KillBehaviors.HARD` this value represents also the timeout for the tasks that you submit to the pool,
48 * 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.
49 * - If `killBehavior` is set to `KillBehaviors.SOFT` your tasks have no timeout and your workers will not be terminated until your task is completed.
50 *
51 * @defaultValue 60000
52 */
53 maxInactiveTime?: number
54 /**
55 * The function to call when a worker is killed.
56 *
57 * @defaultValue `() => {}`
58 */
59 killHandler?: KillHandler
60 }