refactor: refine worker options scope

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

diff --git a/src/pools/pool-internal.ts b/src/pools/pool-internal.ts
index 97e5d5d2d56ae75435b19d1ccb8afae10ff2e8ed..ddfcc41ec40758e8520a2d708bf823aaaebeb39c 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,12 +19,13 @@ export interface TasksUsage {
   running: number
   runTime: number
   avgRunTime: number
+  error: number
 }
 
 /**
  * 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
@@ -33,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,
@@ -42,9 +45,9 @@ export interface IPoolInternal<
   Response = unknown
 > extends IPool<Data, Response> {
   /**
-   * Map of workers.
+   * Pool worker type items array.
    */
-  readonly workers: Map<number, WorkerType<Worker>>
+  readonly workers: Array<WorkerType<Worker>>
 
   /**
    * Pool type.
@@ -54,41 +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 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 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
 }