X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fapi.md;h=f9af05a73780e225d50f0b97ebbbca4f35a433c3;hb=9d96ba4ea0e2e4b06216657cb1641551b59f58ee;hp=8e3c77076f231bda67064b51eba22cd4150c3d77;hpb=d28c70ad5ebe6f2470352954454c94c7bd8459fa;p=poolifier.git diff --git a/docs/api.md b/docs/api.md index 8e3c7707..f9af05a7 100644 --- a/docs/api.md +++ b/docs/api.md @@ -122,11 +122,11 @@ An object with these properties: Default: `{ retries: 6, runTime: { median: false }, waitTime: { median: false }, elu: { median: false } }` -- `startWorkers` (optional) - Start the minimum number of workers at pool creation. +- `startWorkers` (optional) - Start the minimum number of workers at pool initialization. Default: `true` - `restartWorkerOnError` (optional) - Restart worker on uncaught error in this pool. Default: `true` -- `enableEvents` (optional) - Events emission enablement in this pool. +- `enableEvents` (optional) - Events integrated with async resource emission enablement in this pool. Default: `true` - `enableTasksQueue` (optional) - Tasks queue per worker enablement in this pool. Default: `false` @@ -136,8 +136,8 @@ An object with these properties: - `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. - - `taskStealing` (optional) - Task stealing enablement. - - `tasksStealingOnBackPressure` (optional) - Tasks stealing enablement on back pressure. + - `taskStealing` (optional) - Task stealing enablement on empty queue. + - `tasksStealingOnBackPressure` (optional) - Tasks stealing enablement under back pressure. Default: `{ size: (pool maximum size)^2, concurrency: 1, taskStealing: true, tasksStealingOnBackPressure: true }`