From: Jérôme Benoit Date: Thu, 24 Aug 2023 09:46:09 +0000 (+0200) Subject: docs: fix docs/api.md tasks queue options X-Git-Tag: v2.6.35~30 X-Git-Url: https://git.piment-noir.org/?a=commitdiff_plain;h=fa3cc8357657a471129d6f7bd9a12ca28412716c;p=poolifier.git docs: fix docs/api.md tasks queue options Signed-off-by: Jérôme Benoit --- diff --git a/docs/api.md b/docs/api.md index 0474e2aa..e50ebf0d 100644 --- a/docs/api.md +++ b/docs/api.md @@ -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`