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 e0d0534f83a846cbfac77eb87e305e0975c49abf..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',
@@ -17,14 +19,25 @@ export interface TasksUsage {
   running: number
   runTime: number
   avgRunTime: number
+  error: number
+}
+
+/**
+ * Internal worker type.
+ *
+ * @typeParam Worker - Type of worker type items which manages this pool.
+ */
+export interface WorkerType<Worker extends IPoolWorker> {
+  worker: Worker
+  tasksUsage: TasksUsage
 }
 
 /**
  * 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,
@@ -32,17 +45,9 @@ export interface IPoolInternal<
   Response = unknown
 > extends IPool<Data, Response> {
   /**
-   * List of currently available workers.
-   */
-  readonly workers: Worker[]
-
-  /**
-   * The workers tasks usage map.
-   *
-   *  `key`: The `Worker`
-   *  `value`: Worker tasks usage statistics.
+   * Pool worker type items array.
    */
-  readonly workersTasksUsage: Map<Worker, TasksUsage>
+  readonly workers: Array<WorkerType<Worker>>
 
   /**
    * Pool type.
@@ -52,49 +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.
-   */
-  readonly numberOfRunningTasks: number
-
-  /**
-   * Finds a free worker 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 no free worker is found, `false` is returned.
+   * Whether the pool is busy or not.
    *
-   * @returns A free worker if there is one, otherwise `false`.
+   * The pool busyness boolean status.
    */
-  findFreeWorker: () => Worker | false
+  readonly busy: boolean
 
   /**
-   * Gets worker index.
+   * Finds a free worker key based on the number of tasks the worker has applied.
    *
-   * @param worker - The worker.
-   * @returns The worker index.
-   */
-  getWorkerIndex: (worker: Worker) => number
-
-  /**
-   * Gets worker running tasks.
+   * If a worker is found with `0` running tasks, it is detected as free and its key is returned.
    *
-   * @param worker - The worker.
-   * @returns The number of tasks currently running on the worker.
-   */
-  getWorkerRunningTasks: (worker: Worker) => number | undefined
-
-  /**
-   * Gets worker average tasks runtime.
+   * If no free worker is found, `-1` is returned.
    *
-   * @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
 }