X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fpool.ts;h=907bfcb5982f8e1916877e516c3e791eddcc5be0;hb=029715f01bcb30dbd8443bdcbec68484297dd8c6;hp=f7f4e4e5d354791e05b8aee2511f1f5d06354318;hpb=318d4156a8e078eec77d8e3fa8e8697dcc2f4d99;p=poolifier.git diff --git a/src/pools/pool.ts b/src/pools/pool.ts index f7f4e4e5..907bfcb5 100644 --- a/src/pools/pool.ts +++ b/src/pools/pool.ts @@ -98,14 +98,11 @@ export interface PoolOptions { /** * Pool worker tasks queue. * - * @experimental * @defaultValue false */ enableTasksQueue?: boolean /** * Pool worker tasks queue options. - * - * @experimental */ tasksQueueOptions?: TasksQueueOptions } @@ -152,9 +149,9 @@ export interface IPool< */ findFreeWorkerNodeKey: () => number /** - * Execute the function specified in the constructor with the task data parameter. + * Executes the function specified in the constructor with the task data input parameter. * - * @param data - The input for the specified task. This can only be serializable data. + * @param data - The task input data for the specified function. This can only be serializable data. * @returns Promise that will be resolved when the task is successfully completed. */ execute: (data: Data) => Promise @@ -166,6 +163,34 @@ export interface IPool< * Sets the worker choice strategy in this pool. * * @param workerChoiceStrategy - The worker choice strategy. + * @param workerChoiceStrategyOptions - The worker choice strategy options. + */ + setWorkerChoiceStrategy: ( + workerChoiceStrategy: WorkerChoiceStrategy, + workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions + ) => void + /** + * Sets the worker choice strategy options in this pool. + * + * @param workerChoiceStrategyOptions - The worker choice strategy options. + */ + setWorkerChoiceStrategyOptions: ( + workerChoiceStrategyOptions: WorkerChoiceStrategyOptions + ) => void + /** + * Enables/disables the worker tasks queue in this pool. + * + * @param enable - Whether to enable or disable the worker tasks queue. + * @param tasksQueueOptions - The worker tasks queue options. + */ + enableTasksQueue: ( + enable: boolean, + tasksQueueOptions?: TasksQueueOptions + ) => void + /** + * Sets the worker tasks queue options in this pool. + * + * @param tasksQueueOptions - The worker tasks queue options. */ - setWorkerChoiceStrategy: (workerChoiceStrategy: WorkerChoiceStrategy) => void + setTasksQueueOptions: (tasksQueueOptions: TasksQueueOptions) => void }