multi-tasks 1.2.1 → 1.2.3

package/README.md

@@ -12,16 +12,38 @@ How to use:
 ```javascript
 //see examples/example0
 let multiTasks = require('multi-tasks').multiTasks;
+//You need to provide the data of all subtasks, multi-tasks will automatically split them and execute them in a multi-threaded manner
+let alltasks = [];
+for(let i=0;i<100;i++){
+    let task_props = {
+        index: i,
+        name: `task-${i}`,
+        description: `This prop is for a subtask`
+    };
+    alltasks.push(task_props);
+}
+
+//You need to provide a process function to handle a certain sub-task and return the result data
+let processTask = (task)=>{
+    console.log('this is the subtask data you created above:', task);
+    let {index} = task;
+
+    //any exceptions will be captured
+    if(index===3) throw 'exception';
+    if(index===4) return Promise.reject({err:'a test error'});
+
+    //the returned data will be saved
+    return Promise.resolve({
+        message: 'this is a result from a demo, random data=' + Math.random()
+    });
+}
+
 multiTasks({
-    tasks: [...], //You need to provide an array containing all the subtasks you want to execute, multi-tasks will automatically split them and execute them in a multi-threaded manner
-    processTask:(task)=>{//You need to provide a processTask function to process a certain sub-task and return the result data
-        //process your task
-        let data = {...};
-        return Promise.resolve(data);
-    }, 
-    multi_task_parent_folder: `C:/tmp-demo`, //a directory to store progress and results files
-    quotaOfEachTask:2, //The number of tasks assigned to each worker
-    numberOfWorks: 6
+    tasks: alltasks, 
+    processTask, 
+    multi_task_parent_folder: `C:/tmp-demo`, //a directory to store progress and results files, you can check the progress here
+    quotaOfEachTask:1, //The number of subtasks assigned to each worker at one time, the default is 1
+    numberOfWorks: 6 //Assign how many workers are working in parallel
 });
 
 ```
@@ -49,6 +71,8 @@ node examples/example1/run
 
 Changelog:
 
+- 1.2.3 Update README
+- 1.2.2 Update README and examples
 - 1.2.1 Handle exceptions and errors in subtasks
 - 1.2.0 Simplified usage by providing the function way and support return Promise
 - 1.1.4 Remove make-dir

package/examples/example0/run.js

@@ -1,7 +1,8 @@
 let multiTasks = require('../../index').multiTasks;
 
-let alltasks = []
-for(let i=0;i<12;i++){
+//You need to provide the data of all subtasks, multi-tasks will automatically split them and execute them in a multi-threaded manner
+let alltasks = [];
+for(let i=0;i<100;i++){
     let task_props = {
         index: i,
         name: `task-${i}`,
@@ -10,20 +11,25 @@ for(let i=0;i<12;i++){
     alltasks.push(task_props);
 }
 
-let processTask = (actionData)=>{
-    console.log('this is the actionData of one task', actionData);
-    let {index} = actionData;
+//You need to provide a process function to handle a certain sub-task and return the result data
+let processTask = (task)=>{
+    console.log('this is the subtask data you created above:', task);
+    let {index} = task;
+
+    //any exceptions will be captured
     if(index===3) throw 'exception';
     if(index===4) return Promise.reject({err:'a test error'});
+
+    //the returned data will be saved
     return Promise.resolve({
         message: 'this is a result from a demo, random data=' + Math.random()
     });
 }
 
 multiTasks({
-    tasks: alltasks, //You need to provide the data of all subtasks, multi-tasks will automatically split them and execute them in a multi-threaded manner
-    processTask, //You need to provide a processTask function to process a certain sub-task and return the result data
-    multi_task_parent_folder: `C:/tmp-demo`, //a directory to store progress and results files
-    quotaOfEachTask:2, //The number of tasks assigned to each worker
-    numberOfWorks: 6
+    tasks: alltasks, 
+    processTask, 
+    multi_task_parent_folder: `C:/tmp-demo`, //a directory to store progress and results files, you can check the progress here
+    quotaOfEachTask:1, //The number of subtasks assigned to each worker at one time, the default is 1
+    numberOfWorks: 6 //Assign how many workers are working in parallel
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "multi-tasks",
-  "version": "1.2.1",
+  "version": "1.2.3",
   "description": "",
   "main": "index.js",
   "directories": {