X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool-internal.ts;h=c3ec39bea578d3de3c0423f2ef789e0cd6c6f9df;hb=dba3384e0e6bc4049cb114d32e053cc4f2abe010;hp=261a9d7beeb862258ebabceef5b69a71df091180;hpb=c923ce5670eeae4194aa996d44a1071e88cb21ad;p=poolifier.git

diff --git a/src/pools/pool-internal.ts b/src/pools/pool-internal.ts
index 261a9d7b..c3ec39be 100644
--- 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
@@ -34,8 +36,8 @@ export interface WorkerType<Worker extends IPoolWorker> {
  * Internal contract definition for a poolifier pool.
  *
  * @typeParam Worker - Type of worker which manages this pool.
- * @typeParam Data - Type of data sent to the worker.
- * @typeParam Response - Type of response of execution.
+ * @typeParam Data - Type of data sent to the worker. This can only be serializable data.
+ * @typeParam Response - Type of response of execution. This can only be serializable data.
  */
 export interface IPoolInternal<
   Worker extends IPoolWorker,
@@ -43,7 +45,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,25 +57,27 @@ 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.
    *
    * 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, otherwise `false`.
+   * @returns A worker key if there is one, `-1` otherwise.
    */
-  findFreeWorkerKey: () => number | false
+  findFreeWorkerKey: () => number
 }