| 1 | import type { KillBehavior } from '../utility-types' |
| 2 | |
| 3 | /** |
| 4 | * Kill behavior enumeration |
| 5 | */ |
| 6 | export const killBehaviorTypes = Object.freeze({ |
| 7 | SOFT: 'SOFT', |
| 8 | HARD: 'HARD' |
| 9 | }) |
| 10 | |
| 11 | /** |
| 12 | * Options for workers. |
| 13 | */ |
| 14 | export interface WorkerOptions { |
| 15 | /** |
| 16 | * Maximum waiting time in milliseconds for tasks. |
| 17 | * After this time, newly created workers will be terminated. |
| 18 | * 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. |
| 19 | * If killBehavior is set to HARD this value represents also the timeout for the tasks that you submit to the pool, |
| 20 | * when this timeout expires your tasks is interrupted and the worker is killed if is not part of the minimum size of the pool. |
| 21 | * If killBehavior is set to SOFT your tasks have no timeout and your workers will not be terminated until your task is |
| 22 | * |
| 23 | * @default 60.000 ms |
| 24 | */ |
| 25 | maxInactiveTime?: number |
| 26 | /** |
| 27 | * Whether your worker will perform asynchronous or not. |
| 28 | * |
| 29 | * @default false |
| 30 | */ |
| 31 | async?: boolean |
| 32 | /** |
| 33 | * killBehavior dictates if your async unit ( worker/process ) will be deleted in case that a task is active on it. |
| 34 | * SOFT: If current time - last active time is greater than maxInactiveTime option, but a task is still running then the worker will be not deleted. |
| 35 | * HARD: If last active time is greater than maxInactiveTime option, but a task is still running then the worker will be deleted. |
| 36 | * This option only apply to the newly created workers. |
| 37 | * |
| 38 | * @default SOFT |
| 39 | */ |
| 40 | killBehavior?: KillBehavior |
| 41 | } |