-import { EventEmitter } from 'node:events'
-import { type TransferListItem } from 'node:worker_threads'
+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 empty queue.
*
* @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 name - The name of the task function.
* @param fn - The task function.
* @returns `true` if the task function was added, `false` otherwise.
+ * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string or an empty string.
+ * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `fn` parameter is not a function.
*/
readonly addTaskFunction: (
name: string,