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  * Handler called when a worker is killed.
  22  */
  23 export type KillHandler = () => void | Promise<void>
  24
  25 /**
  26  * Options for workers.
  27  */
  28 export interface WorkerOptions {
  29   /**
  30    * `killBehavior` dictates if your worker will be deleted in case a task is active on it.
  31    *
  32    * - SOFT: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still executing or queued, then the worker **won't** be deleted.
  33    * - HARD: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still executing or queued, then the worker will be deleted.
  34    *
  35    * This option only apply to the newly created workers.
  36    *
  37    * @defaultValue KillBehaviors.SOFT
  38    */
  39   killBehavior?: KillBehavior
  40   /**
  41    * Maximum waiting time in milliseconds for tasks on newly created workers.
  42    *
  43    * After this time, newly created workers will be terminated.
  44    * The last active time of your worker will be updated when it terminates a task.
  45    *
  46    * - If `killBehavior` is set to `KillBehaviors.HARD` this value represents also the timeout for the tasks that you submit to the pool,
  47    *   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.
  48    * - If `killBehavior` is set to `KillBehaviors.SOFT` your tasks have no timeout and your workers will not be terminated until your task is completed.
  49    *
  50    * @defaultValue 60000
  51    */
  52   maxInactiveTime?: number
  53   /**
  54    * The function to call when a worker is killed.
  55    */
  56   killHandler?: KillHandler
  57   /**
  58    * Whether your worker will perform asynchronous or not.
  59    *
  60    * @defaultValue false
  61    * @deprecated This option will be removed in the next major version.
  62    */
  63   async?: boolean
  64 }