src/worker/worker-options.ts

   1 /**
   2  * Enumeration of kill behaviors.
   3  */
   4 export const KillBehaviors = Object.freeze({
   5   /**
   6    * If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still executing or queued, then the worker **wont** be deleted.
   7    */
   8   SOFT: 'SOFT',
   9   /**
  10    * If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still executing or queued, then the worker will be deleted.
  11    */
  12   HARD: 'HARD'
  13 } as const)
  14
  15 /**
  16  * Kill behavior.
  17  */
  18 export type KillBehavior = keyof typeof KillBehaviors
  19
  20 /**
  21  * Options for workers.
  22  */
  23 export interface WorkerOptions {
  24   /**
  25    * Maximum waiting time in milliseconds for tasks on newly created workers.
  26    *
  27    * After this time, newly created workers will be terminated.
  28    * The last active time of your worker will be updated when it terminates a task.
  29    *
  30    * - If `killBehavior` is set to `KillBehaviors.HARD` this value represents also the timeout for the tasks that you submit to the pool,
  31    *   when this timeout expires your tasks is interrupted before completion and removed. The worker is killed if is not part of the minimum size of the pool.
  32    * - If `killBehavior` is set to `KillBehaviors.SOFT` your tasks have no timeout and your workers will not be terminated until your task is completed.
  33    *
  34    * @defaultValue 60000
  35    */
  36   maxInactiveTime?: number
  37   /**
  38    * Whether your worker will perform asynchronous or not.
  39    *
  40    * @defaultValue false
  41    * @deprecated This option will be removed in the next major version.
  42    */
  43   async?: boolean
  44   /**
  45    * `killBehavior` dictates if your worker will be deleted in case a task is active on it.
  46    *
  47    * - SOFT: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still executing or queued, then the worker **won't** be deleted.
  48    * - HARD: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still executing or queued, then the worker will be deleted.
  49    *
  50    * This option only apply to the newly created workers.
  51    *
  52    * @defaultValue KillBehaviors.SOFT
  53    */
  54   killBehavior?: KillBehavior
  55 }