Document fixes to worker choice strategies

Signed-off-by: Jérôme Benoit <jerome.benoit@sap.com>

diff --git a/README.md b/README.md
index 9c67d340c2dca6f057a3ce7c31b00d1f44630609..39da874467fe459653b2ecd6aba06d4fe504e303 100644 (file)
--- a/README.md
+++ b/README.md
@@ -156,16 +156,18 @@ You can use node versions >= 12.x for thread pool, and node versions >= 16.x for
 `filePath` (mandatory) Path to a file with a worker implementation  
 `opts` (optional) An object with these properties:
 
+- `messageHandler` (optional) - A function that will listen for message event on each worker
 - `errorHandler` (optional) - A function that will listen for error event on each worker
 - `onlineHandler` (optional) - A function that will listen for online event on each worker
 - `exitHandler` (optional) - A function that will listen for exit event on each worker
-- `workerChoiceStrategy` (optional) - The work choice strategy to use in this pool:
+- `workerChoiceStrategy` (optional) - The worker choice strategy to use in this pool:
 
-  - `WorkerChoiceStrategies.ROUND_ROBIN`: Submit tasks to worker in this pool in a round robbin fashion
-  - `WorkerChoiceStrategies.LESS_RECENTLY_USED`: Submit tasks to the less recently used worker in the pool
-  - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` Submit tasks to worker using a weighted round robin scheduling algorithm based on tasks execution time for now
-  - `WorkerChoiceStrategies.FAIR_SHARE`: Submit tasks to worker using a fair share tasks scheduling algorithm
+  - `WorkerChoiceStrategies.ROUND_ROBIN`: Submit tasks to worker in a round robbin fashion
+  - `WorkerChoiceStrategies.LESS_RECENTLY_USED`: Submit tasks to the less recently used worker
+  - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` Submit tasks to worker using a weighted round robin scheduling algorithm based on tasks execution time
+  - `WorkerChoiceStrategies.FAIR_SHARE`: Submit tasks to worker using a fair share tasks scheduling algorithm based on tasks execution time
 
+  `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` and `WorkerChoiceStrategies.FAIR_SHARE` strategies are targeted to heavy and long tasks
   Default: `WorkerChoiceStrategies.ROUND_ROBIN`
 
 - `enableEvents` (optional) - Events emission enablement in this pool. Default: true
@@ -198,7 +200,7 @@ This method will call the terminate method on each worker.
   If `killBehavior` is set to `KillBehaviors.SOFT` your tasks have no timeout and your workers will not be terminated until your task is completed.  
   Default: 60000 ms
 
-- `async` - true/false, true if your function contains async pieces else false
+- `async` - true/false, true if your function contains async code pieces, else false
 - `killBehavior` - Dictates if your async unit (worker/process) will be deleted in case that a task is active on it.  
   **KillBehaviors.SOFT**: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still running, then the worker **won't** be deleted.  
   **KillBehaviors.HARD**: If `lastActiveTime` is greater than `maxInactiveTime` but a task is still running, then the worker will be deleted.  

diff --git a/src/pools/pool.ts b/src/pools/pool.ts
index e9a093fad6c0287f68f1758a5bc4902d80383317..c6fbce43aba1d6a31d825a1eff80db8aae49ee12 100644 (file)
--- a/src/pools/pool.ts
+++ b/src/pools/pool.ts
@@ -27,7 +27,7 @@ export interface PoolOptions<Worker> {
    */
   exitHandler?: ExitHandler<Worker>
   /**
-   * The work choice strategy to use in this pool.
+   * The worker choice strategy to use in this pool.
    */
   workerChoiceStrategy?: WorkerChoiceStrategy
   /**