X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fapi.md;h=968d6ab5c31e2bcdaaaf82845f24981ac54f8122;hb=32b141fddfba99a275b6e18b5abd97c7a66513be;hp=0a13927586a9dd17c97d9925fce2fe77e4d9ef45;hpb=c3719753af0a9be03abf722a7543495359e817b5;p=poolifier.git diff --git a/docs/api.md b/docs/api.md index 0a139275..968d6ab5 100644 --- a/docs/api.md +++ b/docs/api.md @@ -61,7 +61,7 @@ This method is available on both pool implementations and returns a boolean. ### `pool.addTaskFunction(name, fn)` -`name` (mandatory) The task function name. +`name` (mandatory) The task function name. `fn` (mandatory) The task function. This method is available on both pool implementations and returns a boolean promise. @@ -136,8 +136,9 @@ An object with these properties: - `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 on idle. - `tasksStealingOnBackPressure` (optional) - Tasks stealing enablement under back pressure. + - `tasksFinishedTimeout` (optional) - Queued tasks finished timeout in milliseconds at worker termination. - Default: `{ size: (pool maximum size)^2, concurrency: 1, taskStealing: true, tasksStealingOnBackPressure: true }` + Default: `{ size: (pool maximum size)^2, concurrency: 1, taskStealing: true, tasksStealingOnBackPressure: true, tasksFinishedTimeout: 1000 }` - `workerOptions` (optional) - An object with the worker options to pass to worker. See [worker_threads](https://nodejs.org/api/worker_threads.html#worker_threads_new_worker_filename_options) for more details.