X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool.ts;h=992aaaf1099c7e341daf3bd1c6a937597018b5ea;hb=557991e8ddb66a72a47d62606e142e8be86677f2;hp=396c59ad987ea5c9e8294190587917d8036990b5;hpb=8f52842f4b4fa9059f25fc4a90e8bbe8db2f5e63;p=poolifier.git diff --git a/src/pools/pool.ts b/src/pools/pool.ts index 396c59ad..992aaaf1 100644 --- a/src/pools/pool.ts +++ b/src/pools/pool.ts @@ -83,6 +83,8 @@ export interface PoolOptions { exitHandler?: ExitHandler /** * The worker choice strategy to use in this pool. + * + * @defaultValue WorkerChoiceStrategies.ROUND_ROBIN */ workerChoiceStrategy?: WorkerChoiceStrategy /** @@ -139,22 +141,13 @@ export interface IPool< */ readonly emitter?: PoolEmitter /** - * Finds a free worker node key based on the number of tasks the worker has applied. - * - * If a worker is found with `0` running tasks, it is detected as free and its worker node key is returned. - * - * If no free worker is found, `-1` is returned. - * - * @returns A worker node key if there is one, `-1` otherwise. - */ - findFreeWorkerNodeKey: () => number - /** - * Executes the function specified in the constructor with the task data parameter. + * Executes the function specified in the worker constructor with the task data input parameter. * - * @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. + * @param data - The task input data for the specified worker function. This can only be serializable 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) => Promise + execute: (data?: Data, name?: string) => Promise /** * Shutdowns every current worker in this pool. */