X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool.ts;h=7c6f6769212c45513453af5d3b373f2b752f4c62;hb=c4dfd49dbde2f3af0adc4a33d582b1c653f859b5;hp=0013bf5dc20a27a9b84b63645233d2e636c9df49;hpb=f8350486e75b15ed17249cda3d0a55ee807a6a9f;p=poolifier.git diff --git a/src/pools/pool.ts b/src/pools/pool.ts index 0013bf5d..7c6f6769 100644 --- a/src/pools/pool.ts +++ b/src/pools/pool.ts @@ -31,6 +31,19 @@ export const PoolTypes = Object.freeze({ */ export type PoolType = keyof typeof PoolTypes +/** + * Enumeration of worker types. + */ +export const WorkerTypes = Object.freeze({ + cluster: 'cluster', + thread: 'thread' +} as const) + +/** + * Worker type. + */ +export type WorkerType = keyof typeof WorkerTypes + /** * Pool events emitter. */ @@ -56,14 +69,18 @@ export type PoolEvent = keyof typeof PoolEvents */ export interface PoolInfo { type: PoolType + worker: WorkerType minSize: number maxSize: number + utilization: number workerNodes: number idleWorkerNodes: number busyWorkerNodes: number - runningTasks: number + executedTasks: number + executingTasks: number queuedTasks: number maxQueuedTasks: number + failedTasks: number } /** @@ -136,20 +153,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. */ @@ -172,13 +183,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. + * Terminate every current worker in this pool. */ destroy: () => Promise /**