X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool.ts;h=bf2ac2c251d3052169727dfd6c1bab1d031e7066;hb=cb70b19deb97dc2c8ad1a769e59e870ee37f8e4d;hp=a0663ba523a765878a4566aafe7a667b9ab220f2;hpb=53221c4e8cbcc585c670275e7c1c700c3d1b5f37;p=poolifier.git diff --git a/src/pools/pool.ts b/src/pools/pool.ts index a0663ba5..bf2ac2c2 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,7 +141,7 @@ export interface IPool< */ readonly emitter?: PoolEmitter /** - * Finds a free worker node key based on the number of tasks the worker has applied. + * Finds the first 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. * @@ -149,12 +151,22 @@ export interface IPool< */ findFreeWorkerNodeKey: () => number /** - * Executes the function specified in the constructor with the task data parameter. + * Finds the last 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. + */ + findLastFreeWorkerNodeKey: () => number + /** + * 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. + * @returns Promise that will be fulfilled when the task is completed. */ - execute: (data: Data) => Promise + execute: (data?: Data) => Promise /** * Shutdowns every current worker in this pool. */ @@ -183,7 +195,10 @@ export interface IPool< * @param enable - Whether to enable or disable the worker tasks queue. * @param tasksQueueOptions - The worker tasks queue options. */ - enableTasksQueue: (enable: boolean, opts?: TasksQueueOptions) => void + enableTasksQueue: ( + enable: boolean, + tasksQueueOptions?: TasksQueueOptions + ) => void /** * Sets the worker tasks queue options in this pool. *