X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fapi.md;h=0474e2aabea3a2196d7a3a105f46377bfa8bd7b4;hb=e57eb4d0ea721c4dea66047c431d516f74270453;hp=62d694b6bbb4bf412176705e9f9ffbe2783150c1;hpb=3882157ecadc80e686b319068bd73a9cc218e10c;p=poolifier.git diff --git a/docs/api.md b/docs/api.md index 62d694b6..0474e2aa 100644 --- a/docs/api.md +++ b/docs/api.md @@ -93,9 +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. - `concurrency` (optional) - The maximum number of tasks that can be executed concurrently on a worker. It must be a positive integer. - Default: `{ concurrency: 1 }` + Default: `{ queueMaxSize: (pool maximum size)^2, concurrency: 1 }` #### `ThreadPoolOptions extends PoolOptions`