-
-
Notifications
You must be signed in to change notification settings - Fork 13
/
worker-options.ts
59 lines (56 loc) · 2.13 KB
/
worker-options.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
/**
* Enumeration of kill behaviors.
*/
export const KillBehaviors = Object.freeze({
/**
* If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still executing or queued, then the worker **wont** be deleted.
*/
SOFT: 'SOFT',
/**
* If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still executing or queued, then the worker will be deleted.
*/
HARD: 'HARD'
} as const)
/**
* Kill behavior.
*/
export type KillBehavior = keyof typeof KillBehaviors
/**
* Handler called when a worker is killed.
*/
export type KillHandler = () => void | Promise<void>
/**
* Options for workers.
*/
export interface WorkerOptions {
/**
* `killBehavior` dictates if your worker will be deleted in case a task is active on it.
*
* - SOFT: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still executing or queued, then the worker **won't** be deleted.
* - HARD: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still executing or queued, then the worker will be deleted.
*
* This option only apply to the newly created workers.
*
* @defaultValue KillBehaviors.SOFT
*/
killBehavior?: KillBehavior
/**
* Maximum waiting time in milliseconds for tasks on newly created workers. It must be greater or equal than 5.
*
* After this time, newly created workers will be terminated.
* The last active time of your worker will be updated when it terminates a task.
*
* - 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 before completion and removed. 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
*/
maxInactiveTime?: number
/**
* The function to call when a worker is killed.
*
* @defaultValue `() => {}`
*/
killHandler?: KillHandler
}