docs: fix findFreeWorkerKey() return value

[poolifier.git] / src / pools / pool-internal.ts

diff --git a/src/pools/pool-internal.ts b/src/pools/pool-internal.ts
index 095e954e2c2bb498ad27f1e1a5999686b99249a7..c3ec39bea578d3de3c0423f2ef789e0cd6c6f9df 100644 (file)
--- a/src/pools/pool-internal.ts
+++ b/src/pools/pool-internal.ts
@@ -3,6 +3,8 @@ import type { IPoolWorker } from './pool-worker'
 
 /**
  * Internal pool types.
+ *
+ * @enum
  */
 export enum PoolType {
   FIXED = 'fixed',
@@ -73,7 +75,7 @@ export interface IPoolInternal<
    *
    * If a worker is found with `0` running tasks, it is detected as free and its key is returned.
    *
-   * If no free worker is found, `false` is returned.
+   * If no free worker is found, `-1` is returned.
    *
    * @returns A worker key if there is one, `-1` otherwise.
    */