X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=docs%2Fapi.md;h=bd5ace7a7cc19df75d509e0c7bcf722a7a14f095;hb=9e37a718a5a5ad75a45f9ece38107024b8c2823d;hp=65d96e57171a11e8a813d0b9a100b3e2aacfb8c3;hpb=568d0075825104b5a5ccc38dea2beeb55b55f3d0;p=poolifier.git diff --git a/docs/api.md b/docs/api.md index 65d96e57..bd5ace7a 100644 --- a/docs/api.md +++ b/docs/api.md @@ -111,14 +111,13 @@ An object with these properties: - `workerChoiceStrategyOptions` (optional) - The worker choice strategy options object to use in this pool. Properties: - - `retries` (optional) - The number of retries to perform if no worker is eligible. - `measurement` (optional) - The measurement to use in worker choice strategies: `runTime`, `waitTime` or `elu`. - `runTime` (optional) - Use the tasks [simple moving median](./worker-choice-strategies.md#simple-moving-median) runtime instead of the tasks simple moving average runtime in worker choice strategies. - `waitTime` (optional) - Use the tasks [simple moving median](./worker-choice-strategies.md#simple-moving-median) wait time instead of the tasks simple moving average wait time in worker choice strategies. - `elu` (optional) - Use the tasks [simple moving median](./worker-choice-strategies.md#simple-moving-median) ELU instead of the tasks simple moving average ELU in worker choice strategies. - `weights` (optional) - The worker weights to use in weighted round robin worker choice strategies: `{ 0: 200, 1: 300, ..., n: 100 }`. - Default: `{ retries: 6, runTime: { median: false }, waitTime: { median: false }, elu: { median: false } }` + Default: `{ runTime: { median: false }, waitTime: { median: false }, elu: { median: false } }` - `startWorkers` (optional) - Start the minimum number of workers at pool initialization. Default: `true`