Improvements for #161 (#169)

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

diff --git a/src/worker/worker-options.ts b/src/worker/worker-options.ts
index bdad1a8d68ad59b67a202e20a00603a4f6192719..4473a97533b5c07db172d1c756ae0bce47d1d03a 100644 (file)
--- a/src/worker/worker-options.ts
+++ b/src/worker/worker-options.ts
@@ -1,12 +1,36 @@
-import type { KillBehavior } from '../utility-types'
-
 /**
- * Kill behavior enumeration
+ * Enumeration of kill behaviors.
  */
-export const killBehaviorTypes = Object.freeze({
+export const KillBehaviors = Object.freeze({
+  /**
+   * If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still running, then the worker **wont** be deleted.
+   */
   SOFT: 'SOFT',
+  /**
+   * If `lastActiveTime` is greater than `maxInactiveTime` but a task is still running, then the worker will be deleted.
+   */
   HARD: 'HARD'
-})
+} as const)
+
+/**
+ * Kill behavior.
+ */
+export type KillBehavior = keyof typeof KillBehaviors
+
+/**
+ * Detects whether the given value is a kill behavior or not.
+ *
+ * @template KB Which specific KillBehavior to test against.
+ * @param killBehavior Which kind of kill behavior to detect. Default: `KillBehaviors.HARD`.
+ * @param value Any value.
+ * @returns `true` if `value` was strictly equals to `killBehavior`, otherwise `false`.
+ */
+export function isKillBehavior<KB extends KillBehavior> (
+  killBehavior: KB,
+  value: unknown
+): value is KB {
+  return value === killBehavior
+}
 
 /**
  * Options for workers.
@@ -14,11 +38,13 @@ export const killBehaviorTypes = 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
+   *
+   * - 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.
    *
    * @default 60.000 ms
    */
@@ -30,12 +56,14 @@ export interface WorkerOptions {
    */
   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 running, then the worker **wont** be deleted.
+   * - HARD: If `lastActiveTime` is greater than `maxInactiveTime` but a task is still running, then the worker will be deleted.
+   *
    * This option only apply to the newly created workers.
    *
-   * @default SOFT
+   * @default KillBehaviors.SOFT
    */
   killBehavior?: KillBehavior
 }