Refine some comments
[poolifier.git] / src / worker / worker-options.ts
index 4473a97533b5c07db172d1c756ae0bce47d1d03a..c9a3cdfa6f43c9828f3bb3e60d6ab7e4acc0f757 100644 (file)
@@ -21,7 +21,7 @@ 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 killBehavior Which kind of kill behavior to detect.
  * @param value Any value.
  * @returns `true` if `value` was strictly equals to `killBehavior`, otherwise `false`.
  */
@@ -44,9 +44,9 @@ export interface WorkerOptions {
    *
    * - 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.
+   * - If `killBehavior` is set to `KillBehaviors.SOFT` your tasks have no timeout and your workers will not be terminated until your task is completed.
    *
-   * @default 60.000 ms
+   * @default 60000 ms
    */
   maxInactiveTime?: number
   /**
@@ -58,7 +58,7 @@ export interface WorkerOptions {
   /**
    * `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.
+   * - SOFT: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still running, then the worker **won't** 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.