X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=docs%2Fapi.md;h=513f62c53a450dc6279e7807fcbd855fc63b525a;hb=627fc572465ba2113cbf3df6bd055c3242ecd0fe;hp=458017a18d79ff284a479e16de94580befd44709;hpb=38e6b85b3247f847b61f30efc37851489f106e8a;p=poolifier.git diff --git a/docs/api.md b/docs/api.md index 458017a1..513f62c5 100644 --- a/docs/api.md +++ b/docs/api.md @@ -45,6 +45,14 @@ This method is available on both pool implementations and returns a promise with the task function execution response. +### `pool.mapExecute(data, name, transferList)` + +`data` Iterable objects 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 [`ThreadWorker`](#class-yourworker-extends-threadworkerclusterworker) worker implementation. + +This method is available on both pool implementations and returns a promise with the task function execution responses array. + ### `pool.start()` This method is available on both pool implementations and will start the minimum number of workers. @@ -153,8 +161,8 @@ An object with these properties: `opts` (optional) An object with these properties: - `killBehavior` (optional) - Dictates if your worker will be deleted in case a task is active on it. - **KillBehaviors.SOFT**: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still executing or queued, then the worker **won't** be deleted. - **KillBehaviors.HARD**: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still executing or queued, then the worker will be deleted. + **KillBehaviors.SOFT**: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but the worker is stealing tasks or a task is executing or queued, then the worker **won't** be deleted. + **KillBehaviors.HARD**: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but the worker is stealing tasks or a task is executing or queued, then the worker will be deleted. This option only apply to the newly created workers. Default: `KillBehaviors.SOFT`