X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=src%2Fpools%2Fpool.ts;h=22757f9a54a841597d0394c51675efa25ac08a5d;hb=f294681c4244effd6671e9d3534bf54bbf122d7a;hp=f16c54694ab37240e22d47fca1d97fb3d2ec7196;hpb=184855e69fea29f1018024a34be10de2c8e3141a;p=poolifier.git diff --git a/src/pools/pool.ts b/src/pools/pool.ts index f16c5469..22757f9a 100644 --- a/src/pools/pool.ts +++ b/src/pools/pool.ts @@ -68,16 +68,24 @@ export type PoolEvent = keyof typeof PoolEvents * Pool information. */ export interface PoolInfo { + version: string type: PoolType worker: WorkerType minSize: number maxSize: number + /** Pool utilization ratio. */ + utilization?: number + /** Pool total worker nodes */ workerNodes: number + /** Pool idle worker nodes */ idleWorkerNodes: number + /** Pool busy worker nodes */ busyWorkerNodes: number - runningTasks: number + executedTasks: number + executingTasks: number queuedTasks: number maxQueuedTasks: number + failedTasks: number } /** @@ -89,7 +97,7 @@ export interface TasksQueueOptions { * * @defaultValue 1 */ - concurrency?: number + readonly concurrency?: number } /** @@ -150,20 +158,14 @@ export interface PoolOptions { * Contract definition for a poolifier pool. * * @typeParam Worker - Type of worker which manages this pool. - * @typeParam Data - Type of data sent to the worker. This can only be serializable data. - * @typeParam Response - Type of execution response. This can only be serializable data. + * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data. + * @typeParam Response - Type of execution response. This can only be structured-cloneable data. */ export interface IPool< Worker extends IWorker, Data = unknown, Response = unknown > { - /** - * Pool type. - * - * If it is `'dynamic'`, it provides the `max` property. - */ - readonly type: PoolType /** * Pool information. */ @@ -186,13 +188,13 @@ 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 serializable data. + * @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. * @returns Promise that will be fulfilled when the task is completed. */ execute: (data?: Data, name?: string) => Promise /** - * Shutdowns every current worker in this pool. + * Terminates every current worker in this pool. */ destroy: () => Promise /**