multi-tasks 3.1.2 → 3.1.3

package/README.md

@@ -31,10 +31,10 @@ The API has three parts: the entry functions, the config options, and the `helpe
 - **`numberOfWorkers`** — how many worker processes run in parallel; a number, or a percentage string of CPU cores like `"50%"` (default).
 - **`taskTimeout`** — optional, milliseconds; an overdue task fails with a timeout error.
 - **`maxTaskRetries`** — optional, max times a failed task is auto-retried.
-- **`autoCloseAfterCompletion`** — set `false` if you create new tasks dynamically.
+- **`autoCloseAfterCompletion`** — set `true` to kill workers and exit the process when no tasks are left; default is `false`, i.e. workers stay alive waiting for dynamically created tasks.
 - **`shouldTerminate(info)`** — return `true` to terminate the whole process.
 - **`setSysListener(event, payload, meta)`** — optional, handle custom system events (sent via `helper.emitSys`) on the master; `meta` has `fromWorkerId` and `fromWorkerPid`.
-- **`onFinish(report)`** — called once after all workers are done.
+- **`onFinish(report)`** — called once after all workers exit (only when `autoCloseAfterCompletion` is `true`); `report` is an empty object for now.
 
 **Task helper** (the `helper` object passed as the second argument of `processTask`):
 
@@ -77,7 +77,7 @@ multiTasks({
     numberOfWorkers: 3, //how many workers are working in parallel
     //taskTimeout: 30000, //optional, in milliseconds, an overdue task is treated as failed with a timeout error
     //maxTaskRetries: 2, //optional, auto-retry a failed task (worker crash, processTask error, or timeout); retried tasks go back to the queue
-    //autoCloseAfterCompletion: true, //if you have dynamically generated new tasks, set this to false
+    //autoCloseAfterCompletion: true, //set true to exit the process when all tasks are done; keep it false (default) if you create new tasks dynamically
     shouldTerminate:(info)=>{
         //return true if you need to terminate the whole process
     },
@@ -91,6 +91,8 @@ multiTasks({
 ### More about the task processing function
 
 ```javascript
+//Examples 1-3 below are independent variants of processTask, use one at a time.
+
 //Example1, return a promise for async processes,
 //          you can return a promise or a non-promise result, 
 //          all result data can be found in the results/succ folder
@@ -209,6 +211,7 @@ multiTasks({
 
 ### Changelog:
 
+- 3.1.3 Update README
 - 3.1.2 Update README
 - 3.1.1 Fix readme documentation
 - 3.1.0 Support worker broadcast ('helper.emit' and 'helper.setListener') and system events ('helper.emitSys' and 'setSysListener', with built-in 'TERMINATE_ALL_WORKERS'); default numberOfWorkers is now "50%" of CPU cores (was core count minus 1)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "multi-tasks",
-  "version": "3.1.2",
+  "version": "3.1.3",
   "description": "Multi-process task scheduling based on Node.js cluster, with crash resume and failed-task restart support",
   "main": "index.js",
   "files": [