X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fworker-options.ts;h=7f9c650694b83c5c1675aa0291f2b312711be522;hb=cbae9ada2d10c573e7637261a85b54a7aad76f06;hp=10589643d65764f3d68ffc41345d52e9e19250d4;hpb=2324f8c9233f6e036eee418327c46bb7e71356b9;p=poolifier.git diff --git a/src/worker/worker-options.ts b/src/worker/worker-options.ts index 10589643..7f9c6506 100644 --- a/src/worker/worker-options.ts +++ b/src/worker/worker-options.ts @@ -1,16 +1,17 @@ /** * 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) +export const KillBehaviors: Readonly<{ SOFT: 'SOFT', HARD: 'HARD' }> = + 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. @@ -38,7 +39,7 @@ export interface WorkerOptions { */ killBehavior?: KillBehavior /** - * Maximum waiting time in milliseconds for tasks on newly created workers. + * 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. @@ -56,11 +57,4 @@ export interface WorkerOptions { * @defaultValue `() => {}` */ killHandler?: KillHandler - /** - * Whether your worker will perform asynchronous or not. - * - * @defaultValue false - * @deprecated This option will be removed in the next major version. - */ - async?: boolean }