docs: refine tasks concurrency task queue options description

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

diff --git a/docs/api.md b/docs/api.md
index 7b3766e72cc0978901ac6df7ddfd70bcc9d826ef..a48f4c54c3977dadade267f0ef5ca50e3ae22fda 100644 (file)
--- a/docs/api.md
+++ b/docs/api.md
@@ -93,9 +93,8 @@ An object with these properties:
 - `tasksQueueOptions` (optional) - The worker tasks queue options object to use in this pool.  
   Properties:
 
-  - `concurrency` (optional) - The maximum number of tasks that can be executed concurrently on a worker.
-
-  Default: `{ concurrency: 1 }`
+  - `concurrency` (optional) - The maximum number of tasks that can be executed concurrently on a worker. It must be a positive integer.
+    Default: `{ concurrency: 1 }`
 
 #### `ThreadPoolOptions extends PoolOptions`
 

diff --git a/src/pools/abstract-pool.ts b/src/pools/abstract-pool.ts
index 5932b022230a3ce18c69a803d6efaa596f1cb736..dc1fc53f90bfbda6031a56cfd2c92e62867f07ec 100644 (file)
--- a/src/pools/abstract-pool.ts
+++ b/src/pools/abstract-pool.ts
@@ -300,7 +300,7 @@ export abstract class AbstractPool<
       tasksQueueOptions.concurrency <= 0
     ) {
       throw new Error(
-        `Invalid worker tasks concurrency '${tasksQueueOptions.concurrency}'`
+        `Invalid worker tasks concurrency '${tasksQueueOptions.concurrency}' is a negative integer or zero`
       )
     }
   }