refactor: move helpers to utils.ts file

[poolifier.git] / src / worker / worker-options.ts

diff --git a/src/worker/worker-options.ts b/src/worker/worker-options.ts
index 5d5599e01597d27cdf79c6d7a82b64888e0c6e2f..75d3dd5b98bf1d8e633d3b58c0190cd3c1f20f93 100644 (file)
--- a/src/worker/worker-options.ts
+++ b/src/worker/worker-options.ts
@@ -1,10 +1,21 @@
 /**
- * Kill behavior enumeration
+ * Enumeration of kill behaviors.
  */
-export const killBehaviorEnumeration = Object.freeze({
+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)
+
+/**
+ * Kill behavior.
+ */
+export type KillBehavior = keyof typeof KillBehaviors
 
 /**
  * Options for workers.
@@ -12,28 +23,33 @@ export const killBehaviorEnumeration = Object.freeze({
 export interface WorkerOptions {
   /**
    * Maximum waiting time in milliseconds for tasks.
+   *
    * After this time, newly created workers will be terminated.
    * The last active time of your worker unit will be updated when a task is submitted to a worker or when a worker terminate a task.
-   * If killBehavior is set to HARD this value represents also the timeout for the tasks that you submit to the pool,
-   * when this timeout expires your tasks is interrupted and the worker is killed if is not part of the minimum size of the pool.
-   * If `killBehavior` is set to `SOFT` your tasks have no timeout and your workers will not be terminated until your task is finished.
    *
-   * @default 60.000 ms
+   * - If `killBehavior` is set to `KillBehaviors.HARD` this value represents also the timeout for the tasks that you submit to the pool,
+   *   when this timeout expires your tasks is interrupted and the worker is killed if is not part of the minimum size of the pool.
+   * - If `killBehavior` is set to `KillBehaviors.SOFT` your tasks have no timeout and your workers will not be terminated until your task is completed.
+   *
+   * @defaultValue 60000
    */
   maxInactiveTime?: number
   /**
    * Whether your worker will perform asynchronous or not.
    *
-   * @default false
+   * @defaultValue false
+   * @deprecated This option will be removed in the next major version.
    */
   async?: boolean
   /**
-   * killBehavior dictates if your async unit ( worker/process ) will be deleted in case that a task is active on it.
-   * SOFT: If current time - last active time is greater than `maxInactiveTime` option, but a task is still running then the worker will be not deleted.
-   * HARD: If last active time is greater than maxInactiveTime option, but a task is still running then the worker will be deleted.
+   * `killBehavior` dictates if your async unit (worker/process) will be deleted in case that 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.
    *
-   * @default SOFT
+   * @defaultValue KillBehaviors.SOFT
    */
-  killBehavior?: string
+  killBehavior?: KillBehavior
 }