-import EventEmitter from 'events'
-import type { AbstractPoolWorker } from './abstract-pool-worker'
import type { IPool } from './pool'
+import type { IPoolWorker } from './pool-worker'
/**
- * Pool types.
+ * Internal pool types.
*/
export enum PoolType {
FIXED = 'fixed',
}
/**
- * Tasks usage statistics.
+ * Internal tasks usage statistics.
*/
export interface TasksUsage {
run: number
avgRunTime: number
}
-/**
- * Internal poolifier pool emitter.
- */
-export class PoolEmitter extends EventEmitter {}
-
/**
* 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 AbstractPoolWorker,
+ Worker extends IPoolWorker,
Data = unknown,
Response = unknown
> extends IPool<Data, Response> {
readonly workers: Worker[]
/**
- * Emitter on which events can be listened to.
- *
- * Events that can currently be listened to:
+ * The workers tasks usage map.
*
- * - `'busy'`
+ * `key`: The `Worker`
+ * `value`: Worker tasks usage statistics.
*/
- readonly emitter?: PoolEmitter
+ readonly workersTasksUsage: Map<Worker, TasksUsage>
/**
* Pool type.
*/
readonly type: PoolType
- /**
- * Maximum number of workers that can be created by this pool.
- */
- readonly max?: number
-
/**
* Whether the pool is busy or not.
*
readonly numberOfRunningTasks: number
/**
- * Find a free worker based on the number of tasks the worker has applied.
+ * 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.
*
*
* @returns A free worker if there is one, otherwise `false`.
*/
- findFreeWorker(): Worker | false
+ findFreeWorker: () => Worker | false
/**
- * Get worker index.
+ * Gets worker index.
*
- * @param worker The worker.
+ * @param worker - The worker.
* @returns The worker index.
*/
- getWorkerIndex(worker: Worker): number
+ getWorkerIndex: (worker: Worker) => number
/**
- * Get worker running tasks.
+ * Gets worker running tasks.
*
- * @param worker The worker.
+ * @param worker - The worker.
* @returns The number of tasks currently running on the worker.
*/
- getWorkerRunningTasks(worker: Worker): number | undefined
+ getWorkerRunningTasks: (worker: Worker) => number | undefined
/**
- * Get worker average tasks runtime.
+ * Gets worker average tasks runtime.
*
- * @param worker The worker.
+ * @param worker - The worker.
* @returns The average tasks runtime on the worker.
*/
- getWorkerAverageTasksRunTime(worker: Worker): number | undefined
+ getWorkerAverageTasksRunTime: (worker: Worker) => number | undefined
}