chore: generate documentation

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

diff --git a/src/pools/pool-internal.ts b/src/pools/pool-internal.ts
index 261a9d7beeb862258ebabceef5b69a71df091180..806107ec74ea29402408abaf3cf95a8f0325581c 100644 (file)
--- a/src/pools/pool-internal.ts
+++ b/src/pools/pool-internal.ts
@@ -43,7 +43,7 @@ export interface IPoolInternal<
   Response = unknown
 > extends IPool<Data, Response> {
   /**
-   * Pool workers item array.
+   * Pool worker type items array.
    */
   readonly workers: Array<WorkerType<Worker>>
 
@@ -55,16 +55,18 @@ export interface IPoolInternal<
   readonly type: PoolType
 
   /**
-   * Whether the pool is busy or not.
+   * Whether the pool is full or not.
    *
-   * The pool busyness boolean status.
+   * The pool filling boolean status.
    */
-  readonly busy: boolean
+  readonly full: boolean
 
   /**
-   * Number of tasks currently concurrently running.
+   * Whether the pool is busy or not.
+   *
+   * The pool busyness boolean status.
    */
-  readonly numberOfRunningTasks: number
+  readonly busy: boolean
 
   /**
    * Finds a free worker key based on the number of tasks the worker has applied.
@@ -73,7 +75,7 @@ export interface IPoolInternal<
    *
    * If no free worker is found, `false` is returned.
    *
-   * @returns A worker key if there is one, otherwise `false`.
+   * @returns A worker key if there is one, `-1` otherwise.
    */
-  findFreeWorkerKey: () => number | false
+  findFreeWorkerKey: () => number
 }