docs: fix docs/api.md tasks queue options
authorJérôme Benoit <jerome.benoit@piment-noir.org>
Thu, 24 Aug 2023 09:46:09 +0000 (11:46 +0200)
committerJérôme Benoit <jerome.benoit@piment-noir.org>
Thu, 24 Aug 2023 09:46:09 +0000 (11:46 +0200)
Signed-off-by: Jérôme Benoit <jerome.benoit@piment-noir.org>
docs/api.md

index 0474e2aabea3a2196d7a3a105f46377bfa8bd7b4..e50ebf0dcced0aff6bdb89e21478007534910d2a 100644 (file)
@@ -93,10 +93,10 @@ An object with these properties:
 - `tasksQueueOptions` (optional) - The worker tasks queue options object to use in this pool.  
   Properties:
 
-  - `queueMaxSize` (optional) - The maximum number of tasks that can be queued on a worker before flagging it as back pressured. It must be a positive integer.
+  - `size` (optional) - The maximum number of tasks that can be queued on a worker before flagging it as back pressured. It must be a positive integer.
   - `concurrency` (optional) - The maximum number of tasks that can be executed concurrently on a worker. It must be a positive integer.
 
-  Default: `{ queueMaxSize: (pool maximum size)^2, concurrency: 1 }`
+  Default: `{ size: (pool maximum size)^2, concurrency: 1 }`
 
 #### `ThreadPoolOptions extends PoolOptions`