+import EventEmitter from 'events'
import type {
ErrorHandler,
ExitHandler,
} from './pool-worker'
import type { WorkerChoiceStrategy } from './selection-strategies/selection-strategies-types'
+/**
+ * Pool events emitter.
+ */
+export class PoolEmitter extends EventEmitter {}
+
/**
* Options for a poolifier pool.
*/
*/
exitHandler?: ExitHandler<Worker>
/**
- * The work choice strategy to use in this pool.
+ * The worker choice strategy to use in this pool.
*/
workerChoiceStrategy?: WorkerChoiceStrategy
/**
* Pool events emission.
*
- * @default true
+ * @defaultValue true
*/
enableEvents?: boolean
}
/**
* Contract definition for a poolifier pool.
*
- * @template Data Type of data sent to the worker. This can only be serializable data.
- * @template Response Type of response of execution. This can only be serializable data.
+ * @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 IPool<Data = unknown, Response = unknown> {
/**
- * Perform the task specified in the constructor with the data parameter.
+ * Emitter on which events can be listened to.
+ *
+ * Events that can currently be listened to:
+ *
+ * - `'busy'`
+ */
+ readonly emitter?: PoolEmitter
+ /**
+ * Performs the task specified in the constructor with the data parameter.
*
- * @param data The input for the specified task. This can only be serializable data.
+ * @param data - The input for the specified task. This can only be serializable data.
* @returns Promise that will be resolved when the task is successfully completed.
*/
- execute(data: Data): Promise<Response>
+ execute: (data: Data) => Promise<Response>
/**
* Shutdowns every current worker in this pool.
*/
- destroy(): Promise<void>
+ destroy: () => Promise<void>
/**
- * Set the worker choice strategy in this pool.
+ * Sets the worker choice strategy in this pool.
*
- * @param workerChoiceStrategy The worker choice strategy.
+ * @param workerChoiceStrategy - The worker choice strategy.
*/
- setWorkerChoiceStrategy(workerChoiceStrategy: WorkerChoiceStrategy): void
+ setWorkerChoiceStrategy: (workerChoiceStrategy: WorkerChoiceStrategy) => void
}