@zwa73/utils 1.0.22 → 1.0.23

package/dist/UtilFunctions.d.ts

@@ -1,4 +1,4 @@
-import { JObject } from "./UtilInterfaces";
+import { JObject, JToken } from "./UtilInterfaces";
 /**获取当前时间戳
  * number ()
  * @returns {number} 时间戳
@@ -51,24 +51,39 @@ export declare function ensurePathExistsSync(filePath: string, isDir?: boolean):
 /**加载json文件 同步
  * Object (string)
  * @param {string} filePath - 文件路径
- * @returns {JObject}
+ * @returns {JObject}       - 加载完成的对象或空{}
  */
 export declare function loadJSONFileSync(filePath: string): JObject;
+/**加载json文件 同步
+ * Object (string)
+ * @param {string} filePath - 文件路径
+ * @param {T}      def      - 默认值
+ * @returns {T}             - 加载完成的对象或默认值
+ */
+export declare function loadJSONFileSync<T extends JToken>(filePath: string, def: T): T;
 /**加载json文件 异步
  * Object (string)
  * @async
  * @param {string} filePath - 文件路径
- * @returns {JObject}
+ * @returns {Promise<JObject>} - 加载完成的对象或空{}
  */
 export declare function loadJSONFile(filePath: string): Promise<JObject>;
+/**加载json文件 异步
+ * Object (string)
+ * @async
+ * @param {string} filePath - 文件路径
+ * @param {T}      T        - 默认值
+ * @returns {Promise<T>} - 加载完成的对象或默认值
+ */
+export declare function loadJSONFile<T extends JToken>(filePath: string, def: T): Promise<T>;
 /**写入JSON文件
  * void (string,Object)
  * @async
  * @param {string} filePath - 文件路径
- * @param {JObject} obj 	- 所要写入的JObject
+ * @param {JToken} token 	    - 所要写入的JToken
  * @returns {Promise<void>}
  */
-export declare function writeJSONFile(filePath: string, obj: JObject): Promise<void>;
+export declare function writeJSONFile(filePath: string, token: JToken): Promise<void>;
 /**生成一串uuid
  * string ()
  * @returns {string} uuid

package/dist/UtilFunctions.js

@@ -126,38 +126,35 @@ function ensurePathExistsSync(filePath, isDir) {
     return createPathSync(filePath, isDir);
 }
 exports.ensurePathExistsSync = ensurePathExistsSync;
-/**加载json文件 同步
- * Object (string)
- * @param {string} filePath - 文件路径
- * @returns {JObject}
- */
-function loadJSONFileSync(filePath) {
+function loadJSONFileSync(filePath, def) {
     if (path.extname(filePath) !== '.json')
         filePath += '.json';
     let str = "";
     // 判断文件路径是否存在
     if (pathExistsSync(filePath))
         str = fs.readFileSync(filePath, "utf-8");
-    if (str == "" || str == null)
-        str = "{}";
+    // 如果不存在则返回默认值
+    if (str == "" || str == null) {
+        if (def !== undefined)
+            return def;
+        return {};
+    }
     return JSON.parse(str);
 }
 exports.loadJSONFileSync = loadJSONFileSync;
-/**加载json文件 异步
- * Object (string)
- * @async
- * @param {string} filePath - 文件路径
- * @returns {JObject}
- */
-async function loadJSONFile(filePath) {
+async function loadJSONFile(filePath, def) {
     if (path.extname(filePath) !== '.json')
         filePath += '.json';
     let str = "";
     // 判断文件路径是否存在
     if (await pathExists(filePath))
         str = await fs.promises.readFile(filePath, "utf-8");
-    if (str == "" || str == null)
-        str = "{}";
+    // 如果不存在则返回默认值
+    if (str == "" || str == null) {
+        if (def !== undefined)
+            return def;
+        return {};
+    }
     return JSON.parse(str);
 }
 exports.loadJSONFile = loadJSONFile;
@@ -165,11 +162,11 @@ exports.loadJSONFile = loadJSONFile;
  * void (string,Object)
  * @async
  * @param {string} filePath - 文件路径
- * @param {JObject} obj 	- 所要写入的JObject
+ * @param {JToken} token 	    - 所要写入的JToken
  * @returns {Promise<void>}
  */
-async function writeJSONFile(filePath, obj) {
-    let str = JSON.stringify(obj, null, "\t");
+async function writeJSONFile(filePath, token) {
+    let str = JSON.stringify(token, null, "\t");
     if (path.extname(filePath) !== '.json')
         filePath += '.json';
     // 判断文件路径是否存在 不存在则创建

package/dist/UtilInterfaces.d.ts

@@ -24,7 +24,7 @@ export interface IJData {
      */
     saveToJObject(): JObject;
 }
-export type JDToken = JToken | IJData | JDArray;
+export type JDToken = JToken | IJData | JDArray | JDObject;
 export type JDArray = Array<JDToken>;
 /**可以转换为JObject的Object*/
 export type JDObject = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zwa73/utils",
-  "version": "1.0.22",
+  "version": "1.0.23",
   "description": "my utils",
   "main": "index.js",
   "scripts": {

package/src/UtilFunctions.ts

@@ -1,7 +1,7 @@
 import * as fs from "fs";
 import * as crypto from "crypto";
 import * as path from "path";
-import { JObject } from "./UtilInterfaces";
+import { JArray, JObject, JToken } from "./UtilInterfaces";
 
 /**获取当前时间戳
  * number ()
@@ -131,9 +131,17 @@ export function ensurePathExistsSync(filePath: string, isDir?:boolean):boolean{
 /**加载json文件 同步
  * Object (string)
  * @param {string} filePath - 文件路径
- * @returns {JObject}
+ * @returns {JObject}       - 加载完成的对象或空{}
  */
-export function loadJSONFileSync(filePath: string): JObject {
+export function loadJSONFileSync(filePath: string): JObject
+/**加载json文件 同步
+ * Object (string)
+ * @param {string} filePath - 文件路径
+ * @param {T}      def      - 默认值
+ * @returns {T}             - 加载完成的对象或默认值
+ */
+export function loadJSONFileSync<T extends JToken>(filePath: string,def: T): T
+export function loadJSONFileSync<T extends JToken>(filePath: string,def?: T): T {
     if (path.extname(filePath) !== '.json') filePath += '.json';
 
     let str = "";
@@ -142,16 +150,31 @@ export function loadJSONFileSync(filePath: string): JObject {
     if(pathExistsSync(filePath))
         str = fs.readFileSync(filePath, "utf-8");
 
-    if (str == "" || str == null) str = "{}";
+    // 如果不存在则返回默认值
+    if (str == "" || str == null){
+        if(def!==undefined)
+            return def;
+        return {} as T;
+    }
     return JSON.parse(str);
 }
+
 /**加载json文件 异步
  * Object (string)
  * @async
  * @param {string} filePath - 文件路径
- * @returns {JObject}
+ * @returns {Promise<JObject>} - 加载完成的对象或空{}
  */
-export async function loadJSONFile(filePath: string): Promise<JObject> {
+export async function loadJSONFile(filePath: string): Promise<JObject>
+/**加载json文件 异步
+ * Object (string)
+ * @async
+ * @param {string} filePath - 文件路径
+ * @param {T}      T        - 默认值
+ * @returns {Promise<T>} - 加载完成的对象或默认值
+ */
+export async function loadJSONFile<T extends JToken>(filePath: string,def: T): Promise<T>
+export async function loadJSONFile<T extends JToken>(filePath: string,def?: T): Promise<T> {
     if (path.extname(filePath) !== '.json') filePath += '.json';
 
     let str = "";
@@ -160,7 +183,12 @@ export async function loadJSONFile(filePath: string): Promise<JObject> {
     if(await pathExists(filePath))
         str = await fs.promises.readFile(filePath, "utf-8");
 
-    if (str == "" || str == null) str = "{}";
+    // 如果不存在则返回默认值
+    if (str == "" || str == null){
+        if(def!==undefined)
+            return def;
+        return {} as T;
+    }
     return JSON.parse(str);
 }
 
@@ -168,14 +196,14 @@ export async function loadJSONFile(filePath: string): Promise<JObject> {
  * void (string,Object)
  * @async
  * @param {string} filePath - 文件路径
- * @param {JObject} obj 	- 所要写入的JObject
+ * @param {JToken} token 	    - 所要写入的JToken
  * @returns {Promise<void>}
  */
 export async function writeJSONFile(
     filePath: string,
-    obj: JObject
+    token: JToken
 ): Promise<void> {
-    let str = JSON.stringify(obj, null, "\t");
+    let str = JSON.stringify(token, null, "\t");
     if (path.extname(filePath) !== '.json') filePath += '.json';
 
     // 判断文件路径是否存在 不存在则创建

package/src/UtilInterfaces.ts

@@ -28,12 +28,13 @@ export interface IJData{
 	 */
 	saveToJObject():JObject;
 }
-export type JDToken = JToken|IJData|JDArray;
+export type JDToken = JToken|IJData|JDArray|JDObject;
 export type JDArray = Array<JDToken>;
 /**可以转换为JObject的Object*/
 export type JDObject = {
     [key:string]:JDToken;
 }
+
 /**将JDToken转换为JToken
  * @param {JDToken} token - 待转换的JDToken
  * @returns {JToken} - 转换完成的JToken