X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fworker-options.ts;h=384b2a1104498520719c220aa9300398faf1d2bd;hb=75de9f41ce00bec38febd6d82653d3d82f1bb884;hp=97d4a30a59ed3d47503d59fe55eae393f8e52e9f;hpb=df9aaf207bf2e96ed759f9b89fa6573e8c48fb65;p=poolifier.git diff --git a/src/worker/worker-options.ts b/src/worker/worker-options.ts index 97d4a30a..384b2a11 100644 --- a/src/worker/worker-options.ts +++ b/src/worker/worker-options.ts @@ -20,12 +20,23 @@ export type KillBehavior = keyof typeof KillBehaviors /** * Handler called when a worker is killed. */ -export type KillHandler = () => void +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. * @@ -39,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. * @@ -46,19 +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 - /** - * The function to call when a worker is killed. - */ - killHandler?: KillHandler }