multi-tasks 3.1.0 → 3.1.1

package/README.md

@@ -12,27 +12,36 @@ npm install multi-tasks
 
 ### API:
 
-- `multiTasks(config)` — run tasks; auto-resumes if the task folder already exists or `initialTasks` points to one.
-- `multiTasks.start(config)` — always start a fresh run.
-- `multiTasks.resume(config)` — resume an interrupted run.
-- `multiTasks.restart(config)` — resume and also retry failed tasks (needs `config.taskFolder`).
-- `helper.createNewTasks(tasks)` — create new tasks dynamically while processing.
-- `helper.emit(event, payload, option?)` — broadcast an event to all workers (relayed by the master, best-effort); `option.includingMe` defaults to `true` — pass `{includingMe: false}` to exclude the sender. Payload must be JSON-serializable.
-- `helper.setListener(event, handler)` — listen for broadcast events; one handler per event per worker process (re-registering replaces it), so calling it inside `processTask` is always safe; `handler(payload, meta)` gets `meta.fromWorkerId` and `meta.fromWorkerPid`. Broadcasts are runtime-only messages — not persisted, not replayed on resume.
-- `helper.emitSys(event, payload?)` — send a system event to the master (consumed by the master itself, not relayed). Built-in event: `'TERMINATE_ALL_WORKERS'` force-kills all workers and exits the master; any other event goes to `config.setSysListener`.
-- Config options:
-  - `initialTasks` — array of task objects, or a folder path string to resume from.
-  - `processTask(task, helper)` — required; return a value or a Promise.
-  - `taskRootFolder` — root directory where progress and result files are stored.
-  - `taskId` — task folder name under `taskRootFolder`.
-  - `taskFolder` — full task folder path, required by `restart`.
-  - `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.
-  - `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.
+The API has three parts: the entry functions, the config options, and the `helper` object injected into `processTask`.
+
+**Entry functions:**
+
+- **`multiTasks(config)`** — run tasks; auto-resumes if the task folder already exists or `initialTasks` points to one.
+- **`multiTasks.start(config)`** — always start a fresh run.
+- **`multiTasks.resume(config)`** — resume an interrupted run.
+- **`multiTasks.restart(config)`** — resume and also retry failed tasks (needs `config.taskFolder`).
+
+**Config options:**
+
+- **`initialTasks`** — array of task objects, or a folder path string to resume from.
+- **`processTask(task, helper)`** — required; return a value or a Promise.
+- **`taskRootFolder`** — root directory where progress and result files are stored.
+- **`taskId`** — task folder name under `taskRootFolder`.
+- **`taskFolder`** — full task folder path, required by `restart`.
+- **`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.
+- **`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.
+
+**Task helper** (the `helper` object passed as the second argument of `processTask`):
+
+- **`helper.createNewTasks(tasks)`** — create new tasks dynamically while processing.
+- **`helper.emit(event, payload, option?)`** — broadcast an event to all workers (relayed by the master, best-effort); `option.includingMe` defaults to `true` — pass `{includingMe: false}` to exclude the sender. Payload must be JSON-serializable.
+- **`helper.setListener(event, handler)`** — listen for broadcast events; one handler per event per worker process (re-registering replaces it), so calling it inside `processTask` is always safe; `handler(payload, meta)` gets `meta.fromWorkerId` and `meta.fromWorkerPid`. Broadcasts are runtime-only messages — not persisted, not replayed on resume.
+- **`helper.emitSys(event, payload?)`** — send a system event to the master (consumed by the master itself, not relayed). Built-in event: `'TERMINATE_ALL_WORKERS'` force-kills all workers and exits the master; any other event goes to `config.setSysListener`.
 
 ### How to use:
 
@@ -210,6 +219,7 @@ The usage patterns documented above are covered by automated tests (unit tests i
 
 ### Changelog:
 
+- 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)
 - 3.0.4 numberOfWorkers accepts a percentage string of CPU cores, e.g. "50%"
 - 3.0.3 Support 'maxTaskRetries'

package/package.json

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