docs: sync worker choice context constructor comment

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

diff --git a/src/pools/pool-internal.ts b/src/pools/pool-internal.ts
index 911e761df157a07f54ac1300328c82548cc6d9d6..c3ec39bea578d3de3c0423f2ef789e0cd6c6f9df 100644 (file)
--- a/src/pools/pool-internal.ts
+++ b/src/pools/pool-internal.ts
@@ -1,55 +1,83 @@
-import EventEmitter from 'events'
-import type { IWorker } from './abstract-pool'
 import type { IPool } from './pool'
+import type { IPoolWorker } from './pool-worker'
 
 /**
- * Internal poolifier pool emitter.
+ * Internal pool types.
+ *
+ * @enum
+ */
+export enum PoolType {
+  FIXED = 'fixed',
+  DYNAMIC = 'dynamic'
+}
+
+/**
+ * Internal tasks usage statistics.
  */
-export class PoolEmitter extends EventEmitter {}
+export interface TasksUsage {
+  run: number
+  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.
  *
- * @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. This can only be serializable data.
+ * @typeParam Response - Type of response of execution. This can only be serializable data.
  */
 export interface IPoolInternal<
-  Worker extends IWorker,
+  Worker extends IPoolWorker,
   Data = unknown,
   Response = unknown
 > extends IPool<Data, Response> {
   /**
-   * List of currently available workers.
+   * Pool worker type items array.
    */
-  readonly workers: Worker[]
+  readonly workers: Array<WorkerType<Worker>>
 
   /**
-   * The tasks map.
+   * Pool type.
    *
-   * - `key`: The `Worker`
-   * - `value`: Number of tasks currently in progress on the worker.
+   * If it is `'dynamic'`, it provides the `max` property.
    */
-  readonly tasks: Map<Worker, number>
+  readonly type: PoolType
 
   /**
-   * Emitter on which events can be listened to.
-   *
-   * Events that can currently be listened to:
+   * Whether the pool is full or not.
    *
-   * - `'busy'`
+   * The pool filling boolean status.
    */
-  readonly emitter: PoolEmitter
+  readonly full: boolean
 
   /**
-   * Whether the pool is dynamic or not.
+   * Whether the pool is busy or not.
    *
-   * If it is dynamic, it provides the `max` property.
+   * The pool busyness boolean status.
    */
-  readonly dynamic: boolean
+  readonly busy: boolean
 
   /**
-   * Maximum number of workers that can be created by this pool.
+   * 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, `-1` is returned.
+   *
+   * @returns A worker key if there is one, `-1` otherwise.
    */
-  readonly max?: number
+  findFreeWorkerKey: () => number
 }