/**
* 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
* 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,
Response = unknown
> extends IPool<Data, Response> {
/**
- * Pool workers item array.
+ * Pool worker type items array.
*/
readonly workers: Array<WorkerType<Worker>>
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 key based on the number of tasks the worker has applied.