-
-
Notifications
You must be signed in to change notification settings - Fork 13
/
worker-options.ts
69 lines (66 loc) · 2.37 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
60
61
62
63
64
65
66
67
68
69
/**
* Enumeration of kill behaviors.
*/
export const KillBehaviors = Object.freeze({
/**
* If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still running, then the worker **wont** be deleted.
*/
SOFT: 'SOFT',
/**
* If `lastActiveTime` is greater than `maxInactiveTime` but a task is still running, then the worker will be deleted.
*/
HARD: 'HARD'
} as const)
/**
* Kill behavior.
*/
export type KillBehavior = keyof typeof KillBehaviors
/**
* Detects whether the given value is a kill behavior or not.
*
* @template KB Which specific KillBehavior 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`.
*/
export function isKillBehavior<KB extends KillBehavior> (
killBehavior: KB,
value: unknown
): value is KB {
return value === killBehavior
}
/**
* Options for workers.
*/
export interface WorkerOptions {
/**
* Maximum waiting time in milliseconds for tasks.
*
* After this time, newly created workers will be terminated.
* The last active time of your worker unit will be updated when a task is submitted to a worker or when a worker terminate 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 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.
*
* @default 60.000 ms
*/
maxInactiveTime?: number
/**
* Whether your worker will perform asynchronous or not.
*
* @default false
*/
async?: boolean
/**
* `killBehavior` dictates if your async unit (worker/process) will be deleted in case that a task is active on it.
*
* - SOFT: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still running, then the worker **won't** be deleted.
* - HARD: If `lastActiveTime` is greater than `maxInactiveTime` but a task is still running, then the worker will be deleted.
*
* This option only apply to the newly created workers.
*
* @default KillBehaviors.SOFT
*/
killBehavior?: KillBehavior
}