yann-useorderfun 0.1.0 → 0.1.1

package/README.md

@@ -1,11 +1,59 @@
 # yann-useOrderFun
 
-#### 使用
+## 使用
 
 ```js
-import { useOrderFun } from 'yann-useorderfun';
+import { useOrderFun, useWatchOrderFun } from 'yann-useorderfun';
+import { ref } from 'vue';
 
-const { statusList, result, error, start, suspend } = useOrderFun([f1,f2,f3])
+const f1 = v => {
+  console.log('f1', v);
+  return v + 1;
+};
 
-const [err, res] = await start(data)
-```
+const f2 = v => {
+  return new Promise((resolve, reject) => {
+    console.log('f2', v);
+    resolve(v + 10);
+  });
+};
+
+const wait = time => {
+  return new Promise((resolve, reject) => {
+    setTimeout(() => {
+      resolve();
+    }, time);
+  });
+};
+
+const f3 = async v => {
+  await wait(2000);
+  console.log('f3', v);
+  return v + 100;
+};
+
+// 方案一 手动更新list,手动执行update更新statusList，update可以传递新的list
+// start执行时，会根据list重置statusList的状态
+const list = [f1, f2, f3];
+const { statusList, result, error, start, suspend, update } = useOrderFun(list);
+const [err, res] = await start(data);
+// 如果需要更新 list，可以执行更新函数 update
+update([f1, f2]);
+const [err, res] = await start(data);
+
+// 方案二 自动监听listRef变化，自动更新statusList
+// start执行时，会根据listRef重置statusList的状态
+const listRef = ref([f1, f2, f3]);
+const { statusList, result, error, start, suspend } = useWatchOrderFun(listRef);
+```
+
+## 介绍
+
+|    字段    |   类型   |         描述         |
+| :--------: | :------: | :------------------: |
+| statusList |  array   |   函数列表执行状态   |
+|   result   |   any    |   函数列表最终结果   |
+|   error    |  error   | 函数列表执行错误信息 |
+|   start    | function |       执行函数       |
+|  suspend   | function |       暂停函数       |
+|   update   | function |       更新函数       |