-import { EventEmitter } from 'node:events'
import type { TransferListItem } from 'node:worker_threads'
+import type { EventEmitterAsyncResource } from 'node:events'
import type { TaskFunction } from '../worker/task-functions'
import type {
ErrorHandler,
*/
export type PoolType = keyof typeof PoolTypes
-/**
- * Pool events emitter.
- */
-export class PoolEmitter extends EventEmitter {}
-
/**
* Enumeration of pool events.
*/
*/
readonly concurrency?: number
/**
- * Whether to enable task stealing.
+ * Whether to enable task stealing on idle.
*
* @defaultValue true
*/
readonly taskStealing?: boolean
/**
- * Whether to enable tasks stealing on back pressure.
+ * Whether to enable tasks stealing under back pressure.
*
* @defaultValue true
*/
*/
restartWorkerOnError?: boolean
/**
- * Pool events emission.
+ * Pool events integrated with async resource emission.
*
* @defaultValue true
*/
*/
readonly hasWorkerNodeBackPressure: (workerNodeKey: number) => boolean
/**
- * Emitter on which events can be listened to.
+ * Event emitter integrated with async resource on which events can be listened to.
+ * The async tracking tooling identifier is `poolifier:<PoolType>-<WorkerType>-pool`.
*
* Events that can currently be listened to:
*
* - `'taskError'`: Emitted when an error occurs while executing a task.
* - `'backPressure'`: Emitted when all worker nodes have back pressure (i.e. their tasks queue is full: queue size \>= maximum queue size).
*/
- readonly emitter?: PoolEmitter
+ readonly emitter?: EventEmitterAsyncResource
/**
* Executes the specified function in the worker constructor with the task data input parameter.
*
* @param data - The optional task input data for the specified task function. This can only be structured-cloneable data.
* @param name - The optional name of the task function to execute. If not specified, the default task function will be executed.
- * @param transferList - An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the pool's worker_threads worker and they should not be used in the main thread afterwards.
+ * @param transferList - An optional array of transferable objects to transfer ownership of. Ownership of the transferred objects is given to the chosen pool's worker_threads worker and they should not be used in the main thread afterwards.
* @returns Promise that will be fulfilled when the task is completed.
*/
readonly execute: (