ph-utils 0.5.0 → 0.5.1

package/lib/file.d.ts

@@ -1,14 +1,14 @@
 /**
  * 读取文件内容为JSON格式
  * @param filepath 读取的文件路径
- * @param errIsNull 读取失败时，是否返回 null，默认为 false[抛出异常]
+ * @param defaultValue 读取失败时，提供默认值, 如果不提供传参数则[抛出异常]
  *
- * @example <caption>1. 文件不存在时, 返回null，而不是 catch</caption>
+ * @example <caption>1. 文件不存在时, 默认为: null</caption>
  * await readJSON("./not-exists.json", true);
  *
  * @returns Promise<unknown>
  */
-export declare function readJSON<T>(filepath: string, errIsNull?: boolean): Promise<T>;
+export declare function readJSON<T>(filepath: string, defaultValue?: T): Promise<T>;
 /**
  * 写入 JSON 格式的数据到文件
  * @param file 待写入的文件

package/lib/file.js

@@ -4,19 +4,19 @@ import fs from "node:fs";
 /**
  * 读取文件内容为JSON格式
  * @param filepath 读取的文件路径
- * @param errIsNull 读取失败时，是否返回 null，默认为 false[抛出异常]
+ * @param defaultValue 读取失败时，提供默认值, 如果不提供传参数则[抛出异常]
  *
- * @example <caption>1. 文件不存在时, 返回null，而不是 catch</caption>
+ * @example <caption>1. 文件不存在时, 默认为: null</caption>
  * await readJSON("./not-exists.json", true);
  *
  * @returns Promise<unknown>
  */
-export function readJSON(filepath, errIsNull = false) {
+export function readJSON(filepath, defaultValue) {
     return new Promise((resolve, reject) => {
         fs.readFile(path.resolve(filepath), "utf-8", (err, data) => {
             if (err) {
-                if (errIsNull) {
-                    resolve(null);
+                if (defaultValue !== undefined) {
+                    resolve(defaultValue);
                 }
                 else {
                     reject(err);

package/package.json

@@ -52,7 +52,7 @@
     },
     "./*": "./lib/*"
   },
-  "version": "0.5.0",
+  "version": "0.5.1",
   "type": "module",
   "repository": {
     "type": "git",