} from './selection-strategies/selection-strategies-types'
/**
- * Pool types.
- *
- * @enum
- * @internal
+ * Enumeration of pool types.
*/
-export enum PoolType {
+export const PoolTypes = Object.freeze({
/**
* Fixed pool type.
*/
- FIXED = 'fixed',
+ fixed: 'fixed',
/**
* Dynamic pool type.
*/
- DYNAMIC = 'dynamic'
-}
+ dynamic: 'dynamic'
+} as const)
+
+/**
+ * Pool type.
+ */
+export type PoolType = keyof typeof PoolTypes
+
+/**
+ * Enumeration of worker types.
+ */
+export const WorkerTypes = Object.freeze({
+ cluster: 'cluster',
+ thread: 'thread'
+} as const)
+
+/**
+ * Worker type.
+ */
+export type WorkerType = keyof typeof WorkerTypes
/**
* Pool events emitter.
*/
export const PoolEvents = Object.freeze({
full: 'full',
- busy: 'busy'
+ busy: 'busy',
+ error: 'error',
+ taskError: 'taskError'
} as const)
/**
*/
export type PoolEvent = keyof typeof PoolEvents
+/**
+ * Pool information.
+ */
+export interface PoolInfo {
+ type: PoolType
+ worker: WorkerType
+ minSize: number
+ maxSize: number
+ /** Pool utilization ratio. */
+ utilization: number
+ /** Pool total worker nodes */
+ workerNodes: number
+ /** Pool idle worker nodes */
+ idleWorkerNodes: number
+ /** Pool busy worker nodes */
+ busyWorkerNodes: number
+ executedTasks: number
+ executingTasks: number
+ queuedTasks: number
+ maxQueuedTasks: number
+ failedTasks: number
+}
+
/**
* Worker tasks queue options.
*/
*
* @defaultValue 1
*/
- concurrency?: number
+ readonly concurrency?: number
}
/**
* The worker choice strategy options.
*/
workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
+ /**
+ * Restart worker on error.
+ */
+ restartWorkerOnError?: boolean
/**
* Pool events emission.
*
* Contract definition for a poolifier pool.
*
* @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 execution response. This can only be serializable data.
+ * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data.
+ * @typeParam Response - Type of execution response. This can only be structured-cloneable data.
*/
export interface IPool<
Worker extends IWorker,
Response = unknown
> {
/**
- * Pool type.
- *
- * If it is `'dynamic'`, it provides the `max` property.
- */
- readonly type: PoolType
- /**
- * Pool maximum size.
+ * Pool information.
*/
- readonly size: number
+ readonly info: PoolInfo
/**
* Pool worker nodes.
*/
*
* - `'full'`: Emitted when the pool is dynamic and full.
* - `'busy'`: Emitted when the pool is busy.
+ * - `'error'`: Emitted when an uncaught error occurs.
+ * - `'taskError'`: Emitted when an error occurs while executing a task.
*/
readonly emitter?: PoolEmitter
/**
* Executes the specified function in the worker constructor with the task data input parameter.
*
- * @param data - The task input data for the specified worker function. This can only be serializable data.
+ * @param data - The task input data for the specified worker function. This can only be structured-cloneable data.
* @param name - The name of the worker function to execute. If not specified, the default worker function will be executed.
* @returns Promise that will be fulfilled when the task is completed.
*/
execute: (data?: Data, name?: string) => Promise<Response>
/**
- * Shutdowns every current worker in this pool.
+ * Terminates every current worker in this pool.
*/
destroy: () => Promise<void>
/**