X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool.ts;h=1a05f633250adb8e88c72a63cda565c3265205bc;hb=6b83e544b1827a8a04898c3032dab73fe19687e6;hp=4a0ab725adbaaa5cb08a5740ba195663b554270f;hpb=01a59f3ca06cff8a883c65567320e0a50aa446e3;p=poolifier.git diff --git a/src/pools/pool.ts b/src/pools/pool.ts index 4a0ab725..1a05f633 100644 --- a/src/pools/pool.ts +++ b/src/pools/pool.ts @@ -1,4 +1,5 @@ import { EventEmitter } from 'node:events' +import { type TransferListItem } from 'node:worker_threads' import type { ErrorHandler, ExitHandler, @@ -64,7 +65,7 @@ export interface PoolInfo { readonly strategy: WorkerChoiceStrategy readonly minSize: number readonly maxSize: number - /** Pool utilization ratio. */ + /** Pool utilization. */ readonly utilization?: number /** Pool total worker nodes. */ readonly workerNodes: number @@ -74,8 +75,8 @@ export interface PoolInfo { readonly busyWorkerNodes: number readonly executedTasks: number readonly executingTasks: number - readonly queuedTasks: number - readonly maxQueuedTasks: number + readonly queuedTasks?: number + readonly maxQueuedTasks?: number readonly failedTasks: number readonly runTime?: { readonly minimum: number @@ -192,13 +193,18 @@ export interface IPool< /** * 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 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. * @returns Promise that will be fulfilled when the task is completed. */ - readonly execute: (data?: Data, name?: string) => Promise + readonly execute: ( + data?: Data, + name?: string, + transferList?: TransferListItem[] + ) => Promise /** - * Terminates every current worker in this pool. + * Terminates all workers in this pool. */ readonly destroy: () => Promise /**