-import EventEmitterAsyncResource from 'node:events'
+import { EventEmitter } from 'node:events'
import type {
ErrorHandler,
ExitHandler,
IWorker,
+ IWorkerNode,
MessageHandler,
OnlineHandler,
- WorkerNode
+ WorkerType
} from './worker'
import type {
WorkerChoiceStrategy,
*/
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 class PoolEmitter extends EventEmitterAsyncResource {}
+export class PoolEmitter extends EventEmitter {}
/**
* Enumeration of pool events.
*/
export const PoolEvents = Object.freeze({
full: 'full',
+ ready: 'ready',
busy: 'busy',
error: 'error',
taskError: 'taskError'
* Pool information.
*/
export interface PoolInfo {
- type: PoolType
- worker: WorkerType
- minSize: number
- maxSize: number
- utilization: number
- workerNodes: number
- idleWorkerNodes: number
- busyWorkerNodes: number
- executedTasks: number
- executingTasks: number
- queuedTasks: number
- maxQueuedTasks: number
- failedTasks: number
+ readonly version: string
+ readonly type: PoolType
+ readonly worker: WorkerType
+ readonly ready: boolean
+ readonly strategy: WorkerChoiceStrategy
+ readonly minSize: number
+ readonly maxSize: number
+ /** Pool utilization. */
+ readonly utilization?: number
+ /** Pool total worker nodes. */
+ readonly workerNodes: number
+ /** Pool idle worker nodes. */
+ readonly idleWorkerNodes: number
+ /** Pool busy worker nodes. */
+ readonly busyWorkerNodes: number
+ readonly executedTasks: number
+ readonly executingTasks: number
+ readonly queuedTasks?: number
+ readonly maxQueuedTasks?: number
+ readonly failedTasks: number
+ readonly runTime?: {
+ readonly minimum: number
+ readonly maximum: number
+ readonly average: number
+ readonly median?: number
+ }
+ readonly waitTime?: {
+ readonly minimum: number
+ readonly maximum: number
+ readonly average: number
+ readonly median?: number
+ }
}
/**
*
* @defaultValue 1
*/
- concurrency?: number
+ readonly concurrency?: number
}
/**
/**
* Pool worker nodes.
*/
- readonly workerNodes: Array<WorkerNode<Worker, Data>>
+ readonly workerNodes: Array<IWorkerNode<Worker, Data>>
/**
* Emitter on which events can be listened to.
*
* Events that can currently be listened to:
*
- * - `'full'`: Emitted when the pool is dynamic and full.
- * - `'busy'`: Emitted when the pool is busy.
+ * - `'full'`: Emitted when the pool is dynamic and the number of workers created has reached the maximum size expected.
+ * - `'ready'`: Emitted when the number of workers created in the pool has reached the minimum size expected and are ready.
+ * - `'busy'`: Emitted when the number of workers created in the pool has reached the maximum size expected and are executing at least one task.
* - `'error'`: Emitted when an uncaught error occurs.
* - `'taskError'`: Emitted when an error occurs while executing a task.
*/
/**
* 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 structured-cloneable data.
- * @param name - The name of the worker function to execute. If not specified, the default worker function will be executed.
+ * @param data - The task input data for the specified task function. This can only be structured-cloneable data.
+ * @param name - The name of the task function to execute. If not specified, the default task function will be executed.
* @returns Promise that will be fulfilled when the task is completed.
*/
- execute: (data?: Data, name?: string) => Promise<Response>
+ readonly execute: (data?: Data, name?: string) => Promise<Response>
/**
- * Terminate every current worker in this pool.
+ * Terminates all workers in this pool.
*/
- destroy: () => Promise<void>
+ readonly destroy: () => Promise<void>
/**
* Sets the worker choice strategy in this pool.
*
* @param workerChoiceStrategy - The worker choice strategy.
* @param workerChoiceStrategyOptions - The worker choice strategy options.
*/
- setWorkerChoiceStrategy: (
+ readonly setWorkerChoiceStrategy: (
workerChoiceStrategy: WorkerChoiceStrategy,
workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions
) => void
*
* @param workerChoiceStrategyOptions - The worker choice strategy options.
*/
- setWorkerChoiceStrategyOptions: (
+ readonly setWorkerChoiceStrategyOptions: (
workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
) => void
/**
* @param enable - Whether to enable or disable the worker tasks queue.
* @param tasksQueueOptions - The worker tasks queue options.
*/
- enableTasksQueue: (
+ readonly enableTasksQueue: (
enable: boolean,
tasksQueueOptions?: TasksQueueOptions
) => void
*
* @param tasksQueueOptions - The worker tasks queue options.
*/
- setTasksQueueOptions: (tasksQueueOptions: TasksQueueOptions) => void
+ readonly setTasksQueueOptions: (tasksQueueOptions: TasksQueueOptions) => void
}