@bettergi/utils 0.1.6 → 0.1.8

package/README.md

@@ -174,6 +174,20 @@ const d1 = getNextDay4AM();
 const d2 = getNextMonday4AM();
 ```
 
+### 异常
+
+```ts
+// 重复执行某个可能失败的异步操作，但是发生主机异常（如任务取消）时停止
+for (let i = 0; i < 1000; i++) {
+  try {
+    await sleep(i);
+  } catch (err: any) {
+    if (isHostException(err)) throw err;
+    log.info(`第 ${i} 次运行失败，错误信息：${err.message}`);
+  }
+}
+```
+
 ### 杂项
 
 ```ts
@@ -183,4 +197,7 @@ const uuid = generateUUID(false);
 // 数组洗牌
 const arr = [1, 2, 3, 4, 5];
 const shuffled = shuffleArray(arr);
+
+// 深度合并多个对象：{ x: 1, y: { a: 2, b: 4, c: 5 }, d: 6 }
+const result = deepMerge({ x: 1, y: { a: 2, b: 3 } }, { y: { b: 4, c: 5 }, d: 6 });
 ```

package/dist/exception.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 判断是否为主机异常
+ * @param err 异常对象
+ */
+export declare const isHostException: (err: any) => boolean;
+/**
+ * 判断是否为任务取消异常
+ * @param err 异常对象
+ */
+export declare const isTaskCanceledException: (err: any) => any;

package/dist/exception.js

@@ -0,0 +1,16 @@
+/**
+ * 判断是否为主机异常
+ * @param err 异常对象
+ */
+export const isHostException = (err) => {
+    return typeof err === "object" && Object.prototype.hasOwnProperty.call(err, "hostException");
+};
+/**
+ * 判断是否为任务取消异常
+ * @param err 异常对象
+ */
+export const isTaskCanceledException = (err) => {
+    return (isHostException(err) &&
+        typeof err?.message === "string" &&
+        err.message.includes("task was canceled"));
+};

package/dist/index.d.ts

@@ -1,5 +1,7 @@
 /** 断言 */
 export * from "./asserts";
+/** 异常 */
+export * from "./exception";
 /** 文件操作 */
 export * from "./file";
 /** 游戏操作 */

package/dist/index.js

@@ -1,5 +1,7 @@
 /** 断言 */
 export * from "./asserts";
+/** 异常 */
+export * from "./exception";
 /** 文件操作 */
 export * from "./file";
 /** 游戏操作 */

package/dist/misc.d.ts

@@ -9,3 +9,9 @@ export declare const generateUUID: (withDashes?: boolean) => string;
  * @returns 洗牌后的新数组
  */
 export declare const shuffleArray: <T>(array: T[]) => T[];
+/**
+ * 深度合并多个对象
+ * @param objects 多个对象
+ * @returns 合并后的对象副本
+ */
+export declare const deepMerge: (...objects: any[]) => any;

package/dist/misc.js

@@ -24,3 +24,18 @@ export const shuffleArray = (array) => {
     }
     return shuffled;
 };
+/**
+ * 深度合并多个对象
+ * @param objects 多个对象
+ * @returns 合并后的对象副本
+ */
+export const deepMerge = (...objects) => {
+    const isPlainObject = (input) => input?.constructor === Object;
+    return objects.reduce((result, obj) => {
+        return Object.entries(obj).reduce((acc, [key, value]) => {
+            const recursive = isPlainObject(acc[key]) && isPlainObject(value);
+            acc[key] = recursive ? deepMerge(acc[key], value) : value;
+            return acc;
+        }, result);
+    }, {});
+};

package/dist/store.d.ts

@@ -5,3 +5,9 @@
  * @param name 存储对象的名称，将作为文件名（不包扩展名）
  */
 export declare const useStore: <T extends Record<string, any>>(name: string) => T;
+/**
+ * 创建一个带有默认值的持久化存储对象，用于管理应用状态数据
+ * @param name 存储对象的名称，将作为文件名（不包扩展名）
+ * @param defaults 默认值数据对象
+ */
+export declare const useStoreWithDefaults: <T extends Record<string, any>>(name: string, defaults: Partial<T>) => T;

package/dist/store.js

@@ -1,3 +1,4 @@
+import { deepMerge } from "./misc";
 /**
  * 创建一个持久化存储对象，用于管理应用状态数据
  * 该函数会创建一个代理对象，对该对象的所有属性的修改都会自动同步到相应的JSON文件（脚本的 `store` 目录下）中。
@@ -50,3 +51,13 @@ export const useStore = (name) => {
     };
     return createProxy(obj);
 };
+/**
+ * 创建一个带有默认值的持久化存储对象，用于管理应用状态数据
+ * @param name 存储对象的名称，将作为文件名（不包扩展名）
+ * @param defaults 默认值数据对象
+ */
+export const useStoreWithDefaults = (name, defaults) => {
+    const store = useStore(name);
+    Object.assign(store, deepMerge(defaults, store));
+    return store;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bettergi/utils",
-  "version": "0.1.6",
+  "version": "0.1.8",
   "description": "开发 BetterGI 脚本常用工具集",
   "type": "module",
   "author": "Bread Grocery<https://github.com/breadgrocery>",