docs: refine README to include latest API changes

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

diff --git a/src/worker/worker-options.ts b/src/worker/worker-options.ts
index 4e5a3d07d99c372b5d24854471d6b97f9c297566..e0cd392f0966769f197859b67bd53e4c1b8304f1 100644 (file)
--- a/src/worker/worker-options.ts
+++ b/src/worker/worker-options.ts
@@ -20,15 +20,15 @@ export type KillBehavior = keyof typeof KillBehaviors
 /**
  * Detects whether the given value is a kill behavior or not.
  *
- * @typeParam KB - Which specific KillBehavior to test against.
+ * @typeParam KB - Which specific KillBehavior type to test against.
  * @param killBehavior - Which kind of kill behavior to detect.
  * @param value - Any value.
  * @returns `true` if `value` was strictly equals to `killBehavior`, otherwise `false`.
  */
-export function isKillBehavior<KB extends KillBehavior> (
+export const isKillBehavior = <KB extends KillBehavior>(
   killBehavior: KB,
   value: unknown
-): value is KB {
+): value is KB => {
   return value === killBehavior
 }
 
@@ -46,13 +46,14 @@ export interface WorkerOptions {
    *   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 ms
+   * @defaultValue 60000
    */
   maxInactiveTime?: number
   /**
    * Whether your worker will perform asynchronous or not.
    *
    * @defaultValue false
+   * @deprecated This option will be removed in the next major version.
    */
   async?: boolean
   /**