X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fapi.md;h=28282ac2314bc05322098d09ad5ad0d08a163595;hb=b4e93467358d93166716dc6e5075d58c18c961c7;hp=2b917c46c362157b7616771d2eab174f7dfa9463;hpb=b51d859692c3830760721f06bdb2c909c1d5d9a7;p=poolifier.git diff --git a/docs/api.md b/docs/api.md index 2b917c46..28282ac2 100644 --- a/docs/api.md +++ b/docs/api.md @@ -43,7 +43,7 @@ `data` (optional) An object that you want to pass to your worker task function implementation. `name` (optional) A string with the task function name that you want to execute on the worker. Default: `'default'` -`transferList` (optional) An array of transferable objects that you want to transfer to your [worker_threads](https://nodejs.org/api/worker_threads.html) worker implementation. +`transferList` (optional) An array of transferable objects that you want to transfer to your [`ThreadWorker`](#class-yourworker-extends-threadworkerclusterworker) worker implementation. This method is available on both pool implementations and returns a promise with the task function execution response. @@ -136,7 +136,7 @@ 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 on empty queue. + - `taskStealing` (optional) - Task stealing enablement on idle. - `tasksStealingOnBackPressure` (optional) - Tasks stealing enablement under back pressure. Default: `{ size: (pool maximum size)^2, concurrency: 1, taskStealing: true, tasksStealingOnBackPressure: true }`