X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fapi.md;h=1b888173d13db4519a17dd786364ca3cd6247d8b;hb=7852d4885f5cf93f22eade3d335d80cde0a67391;hp=db56dc435de10760df69ec48a80d8a5e6b2d4201;hpb=75f30e744551af87736f998db9ad02be7206e89e;p=poolifier.git diff --git a/docs/api.md b/docs/api.md index db56dc43..1b888173 100644 --- a/docs/api.md +++ b/docs/api.md @@ -98,7 +98,7 @@ An object with these properties: - `workerChoiceStrategy` (optional) - The default worker choice strategy to use in this pool: - `WorkerChoiceStrategies.ROUND_ROBIN`: Submit tasks to worker in a round robin fashion - - `WorkerChoiceStrategies.LEAST_USED`: Submit tasks to the worker with the minimum number of executed, executing and queued tasks + - `WorkerChoiceStrategies.LEAST_USED`: Submit tasks to the worker with the minimum number of executing and queued tasks - `WorkerChoiceStrategies.LEAST_BUSY`: Submit tasks to the worker with the minimum tasks total execution and wait time - `WorkerChoiceStrategies.LEAST_ELU`: Submit tasks to the worker with the minimum event loop utilization (ELU) - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN`: Submit tasks to worker by using a [weighted round robin scheduling algorithm](./worker-choice-strategies.md#weighted-round-robin) based on tasks execution time @@ -115,7 +115,7 @@ An object with these properties: - `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 }`. + - `weights` (optional) - The worker weights to use in weighted round robin worker choice strategies: `Record`. Default: `{ runTime: { median: false }, waitTime: { median: false }, elu: { median: false } }`