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 2d92f2f0c48dac3c25a190aefa5485cde5f8715e..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',
@@ -23,7 +25,7 @@ export interface TasksUsage {
 /**
  * Internal worker type.
  *
- * @typeParam Worker - Type of worker which manages this pool.
+ * @typeParam Worker - Type of worker type items which manages this pool.
  */
 export interface WorkerType<Worker extends IPoolWorker> {
   worker: Worker
@@ -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.
    */