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 470ccdd5938e04ac8585ddc1fb6afc906919d02e..806107ec74ea29402408abaf3cf95a8f0325581c 100644 (file)
--- a/src/pools/pool-internal.ts
+++ b/src/pools/pool-internal.ts
@@ -17,14 +17,25 @@ export interface TasksUsage {
   running: number
   runTime: number
   avgRunTime: number
+  error: number
+}
+
+/**
+ * Internal worker type.
+ *
+ * @typeParam Worker - Type of worker which manages this pool.
+ */
+export interface WorkerType<Worker extends IPoolWorker> {
+  worker: Worker
+  tasksUsage: TasksUsage
 }
 
 /**
  * Internal contract definition for a poolifier pool.
  *
- * @template Worker Type of worker which manages this pool.
- * @template Data Type of data sent to the worker.
- * @template Response Type of response of execution.
+ * @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.
  */
 export interface IPoolInternal<
   Worker extends IPoolWorker,
@@ -32,17 +43,9 @@ export interface IPoolInternal<
   Response = unknown
 > extends IPool<Data, Response> {
   /**
-   * List of currently available workers.
+   * Pool worker type items array.
    */
-  readonly workers: Worker[]
-
-  /**
-   * The workers tasks usage map.
-   *
-   *  `key`: The `Worker`
-   *  `value`: Worker tasks usage statistics.
-   */
-  readonly workersTasksUsage: Map<Worker, TasksUsage>
+  readonly workers: Array<WorkerType<Worker>>
 
   /**
    * Pool type.
@@ -52,9 +55,11 @@ export interface IPoolInternal<
   readonly type: PoolType
 
   /**
-   * Maximum number of workers that can be created by this pool.
+   * Whether the pool is full or not.
+   *
+   * The pool filling boolean status.
    */
-  readonly max?: number
+  readonly full: boolean
 
   /**
    * Whether the pool is busy or not.
@@ -64,42 +69,13 @@ export interface IPoolInternal<
   readonly busy: boolean
 
   /**
-   * Number of tasks currently concurrently running.
-   */
-  readonly numberOfRunningTasks: number
-
-  /**
-   * Finds a free worker based on the number of tasks the worker has applied.
+   * 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 returned.
+   * 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.
    *
-   * @returns A free worker if there is one, otherwise `false`.
-   */
-  findFreeWorker(): Worker | false
-
-  /**
-   * Gets worker index.
-   *
-   * @param worker The worker.
-   * @returns The worker index.
-   */
-  getWorkerIndex(worker: Worker): number
-
-  /**
-   * Gets worker running tasks.
-   *
-   * @param worker The worker.
-   * @returns The number of tasks currently running on the worker.
-   */
-  getWorkerRunningTasks(worker: Worker): number | undefined
-
-  /**
-   * Gets worker average tasks runtime.
-   *
-   * @param worker The worker.
-   * @returns The average tasks runtime on the worker.
+   * @returns A worker key if there is one, `-1` otherwise.
    */
-  getWorkerAverageTasksRunTime(worker: Worker): number | undefined
+  findFreeWorkerKey: () => number
 }