X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fworker-options.ts;h=384b2a1104498520719c220aa9300398faf1d2bd;hb=472f3f1a5d003abdbb94c5ce808de7c44bfe90ab;hp=e6137c7fc659b6e989f510cab0f090a2058b01d3;hpb=b0a4db63f53f4df5d60abc592f32043468626574;p=poolifier.git diff --git a/src/worker/worker-options.ts b/src/worker/worker-options.ts index e6137c7f..384b2a11 100644 --- a/src/worker/worker-options.ts +++ b/src/worker/worker-options.ts @@ -17,10 +17,26 @@ export const KillBehaviors = Object.freeze({ */ export type KillBehavior = keyof typeof KillBehaviors +/** + * Handler called when a worker is killed. + */ +export type KillHandler = () => void | Promise + /** * 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. * @@ -34,6 +50,10 @@ export interface WorkerOptions { * @defaultValue 60000 */ maxInactiveTime?: number + /** + * The function to call when a worker is killed. + */ + killHandler?: KillHandler /** * Whether your worker will perform asynchronous or not. * @@ -41,15 +61,4 @@ export interface WorkerOptions { * @deprecated This option will be removed in the next major version. */ async?: boolean - /** - * `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 }