import type { EventEmitterAsyncResource } from 'node:events'
import type { TransferListItem, WorkerOptions } from 'node:worker_threads'
+import type { TaskFunctionProperties } from '../utility-types.js'
import type { TaskFunction } from '../worker/task-functions.js'
import type {
WorkerChoiceStrategy,
/**
* Enumeration of pool types.
*/
-export const PoolTypes = Object.freeze({
+export const PoolTypes: Readonly<{
+ fixed: 'fixed'
+ dynamic: 'dynamic'
+}> = Object.freeze({
/**
* Fixed pool type.
*/
/**
* Enumeration of pool events.
*/
-export const PoolEvents = Object.freeze({
+export const PoolEvents: Readonly<{
+ ready: 'ready'
+ busy: 'busy'
+ full: 'full'
+ empty: 'empty'
+ destroy: 'destroy'
+ error: 'error'
+ taskError: 'taskError'
+ backPressure: 'backPressure'
+}> = Object.freeze({
ready: 'ready',
busy: 'busy',
full: 'full',
readonly worker: WorkerType
readonly started: boolean
readonly ready: boolean
- readonly strategy: WorkerChoiceStrategy
+ readonly defaultStrategy: WorkerChoiceStrategy
readonly strategyRetries: number
readonly minSize: number
readonly maxSize: number
/**
* Whether to enable tasks stealing under back pressure.
*
- * @defaultValue true
+ * @defaultValue false
*/
readonly tasksStealingOnBackPressure?: boolean
/**
*/
startWorkers?: boolean
/**
- * The worker choice strategy to use in this pool.
+ * The default worker choice strategy to use in this pool.
*
* @defaultValue WorkerChoiceStrategies.ROUND_ROBIN
*/
*/
readonly workerNodes: Array<IWorkerNode<Worker, Data>>
/**
- * Event emitter integrated with async resource on which events can be listened to.
+ * Pool event emitter integrated with async resource.
* The async tracking tooling identifier is `poolifier:<PoolType>-<WorkerType>-pool`.
*
* Events that can currently be listened to:
readonly execute: (
data?: Data,
name?: string,
- transferList?: TransferListItem[]
+ transferList?: readonly TransferListItem[]
) => Promise<Response>
/**
* Starts the minimum number of workers in this pool.
*/
readonly removeTaskFunction: (name: string) => Promise<boolean>
/**
- * Lists the names of task function available in this pool.
+ * Lists the properties of task functions available in this pool.
*
- * @returns The names of task function available in this pool.
+ * @returns The properties of task functions available in this pool.
*/
- readonly listTaskFunctionNames: () => string[]
+ readonly listTaskFunctionsProperties: () => TaskFunctionProperties[]
/**
* Sets the default task function in this pool.
*
*/
readonly setDefaultTaskFunction: (name: string) => Promise<boolean>
/**
- * Sets the worker choice strategy in this pool.
+ * Sets the default worker choice strategy in this pool.
*
- * @param workerChoiceStrategy - The worker choice strategy.
+ * @param workerChoiceStrategy - The default worker choice strategy.
* @param workerChoiceStrategyOptions - The worker choice strategy options.
*/
readonly setWorkerChoiceStrategy: (
* Sets the worker choice strategy options in this pool.
*
* @param workerChoiceStrategyOptions - The worker choice strategy options.
+ * @returns `true` if the worker choice strategy options were set, `false` otherwise.
*/
readonly setWorkerChoiceStrategyOptions: (
workerChoiceStrategyOptions: WorkerChoiceStrategyOptions
- ) => void
+ ) => boolean
/**
* Enables/disables the worker node tasks queue in this pool.
*