@zwa73/utils 1.0.16 → 1.0.18

package/dist/UtilFunctions.d.ts

@@ -13,6 +13,7 @@ export declare function getTime(): number;
  */
 export declare function initField<T>(obj: Record<string, T>, field: string, defaultVal: T): T;
 /**验证路径 文件或文件夹 是否存在 异步
+ * @async
  * @param {string} filePath - 待验证的路径
  * @returns {Promise<boolean>} - 是否存在
  */
@@ -22,16 +23,31 @@ export declare function pathExists(filePath: string): Promise<boolean>;
  * @returns {boolean} - 是否存在
  */
 export declare function pathExistsSync(filePath: string): boolean;
-/**创建路径 path.sep 结尾时创建文件夹 异步
+/**路径不存在时创建路径 以path.sep结尾时创建文件夹 异步
+ * @async
  * @param {string} filePath - 待创建的路径
+ * @param {boolean} isDir   - 强制创建一个文件夹
  * @returns {Promise<boolean>} - 是否成功创建
  */
-export declare function createPath(filePath: string): Promise<boolean>;
-/**创建路径 path.sep 结尾时创建文件夹 同步
+export declare function createPath(filePath: string, isDir?: boolean): Promise<boolean>;
+/**路径不存在时创建路径 以path.sep结尾时创建文件夹 同步
  * @param {string} filePath - 待创建的路径
+ * @param {boolean} isDir   - 强制验证一个文件夹
  * @returns {boolean} - 是否成功创建
  */
-export declare function createPathSync(filePath: string): boolean;
+export declare function createPathSync(filePath: string, isDir?: boolean): boolean;
+/**确保路径存在 不存在时创建 异步
+ * @async
+ * @param {string} filePath - 待验证的路径
+ * @param {boolean} isDir   - 强制验证一个文件夹
+ * @returns {Promise<boolean>} - 是否成功执行 创建或已存在
+ */
+export declare function ensurePathExists(filePath: string, isDir?: boolean): Promise<boolean>;
+/**确保路径存在 不存在时创建 同步
+ * @param {string} filePath - 待验证的路径
+ * @returns {boolean} - 是否成功执行 创建或已存在
+ */
+export declare function ensurePathExistsSync(filePath: string, isDir?: boolean): boolean;
 /**加载json文件 同步
  * Object (string)
  * @param {string} filePath - 文件路径

package/dist/UtilFunctions.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fileSearch = exports.sleep = exports.isSafeNumber = exports.deepClone = exports.genUUID = exports.writeJSONFile = exports.loadJSONFile = exports.loadJSONFileSync = exports.createPathSync = exports.createPath = exports.pathExistsSync = exports.pathExists = exports.initField = exports.getTime = void 0;
+exports.fileSearch = exports.sleep = exports.isSafeNumber = exports.deepClone = exports.genUUID = exports.writeJSONFile = exports.loadJSONFile = exports.loadJSONFileSync = exports.ensurePathExistsSync = exports.ensurePathExists = exports.createPathSync = exports.createPath = exports.pathExistsSync = exports.pathExists = exports.initField = exports.getTime = void 0;
 const fs = require("fs");
 const crypto = require("crypto");
 const path = require("path");
@@ -26,6 +26,7 @@ function initField(obj, field, defaultVal) {
 }
 exports.initField = initField;
 /**验证路径 文件或文件夹 是否存在 异步
+ * @async
  * @param {string} filePath - 待验证的路径
  * @returns {Promise<boolean>} - 是否存在
  */
@@ -54,11 +55,15 @@ function pathExistsSync(filePath) {
     }
 }
 exports.pathExistsSync = pathExistsSync;
-/**创建路径 path.sep 结尾时创建文件夹 异步
+/**路径不存在时创建路径 以path.sep结尾时创建文件夹 异步
+ * @async
  * @param {string} filePath - 待创建的路径
+ * @param {boolean} isDir   - 强制创建一个文件夹
  * @returns {Promise<boolean>} - 是否成功创建
  */
-async function createPath(filePath) {
+async function createPath(filePath, isDir) {
+    if (isDir == true)
+        filePath = path.join(filePath, path.sep);
     try {
         if (filePath.endsWith(path.sep)) {
             await fs.promises.mkdir(filePath, { recursive: true });
@@ -75,11 +80,14 @@ async function createPath(filePath) {
     }
 }
 exports.createPath = createPath;
-/**创建路径 path.sep 结尾时创建文件夹 同步
+/**路径不存在时创建路径 以path.sep结尾时创建文件夹 同步
  * @param {string} filePath - 待创建的路径
+ * @param {boolean} isDir   - 强制验证一个文件夹
  * @returns {boolean} - 是否成功创建
  */
-function createPathSync(filePath) {
+function createPathSync(filePath, isDir) {
+    if (isDir == true)
+        filePath = path.join(filePath, path.sep);
     try {
         if (filePath.endsWith(path.sep)) {
             fs.mkdirSync(filePath, { recursive: true });
@@ -96,6 +104,28 @@ function createPathSync(filePath) {
     }
 }
 exports.createPathSync = createPathSync;
+/**确保路径存在 不存在时创建 异步
+ * @async
+ * @param {string} filePath - 待验证的路径
+ * @param {boolean} isDir   - 强制验证一个文件夹
+ * @returns {Promise<boolean>} - 是否成功执行 创建或已存在
+ */
+async function ensurePathExists(filePath, isDir) {
+    if (await pathExists(filePath))
+        return true;
+    return await createPath(filePath, isDir);
+}
+exports.ensurePathExists = ensurePathExists;
+/**确保路径存在 不存在时创建 同步
+ * @param {string} filePath - 待验证的路径
+ * @returns {boolean} - 是否成功执行 创建或已存在
+ */
+function ensurePathExistsSync(filePath, isDir) {
+    if (pathExistsSync(filePath))
+        return true;
+    return createPathSync(filePath, isDir);
+}
+exports.ensurePathExistsSync = ensurePathExistsSync;
 /**加载json文件 同步
  * Object (string)
  * @param {string} filePath - 文件路径

package/package.json

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

package/src/UtilFunctions.ts

@@ -28,6 +28,7 @@ export function initField<T>(
 }
 
 /**验证路径 文件或文件夹 是否存在 异步
+ * @async
  * @param {string} filePath - 待验证的路径
  * @returns {Promise<boolean>} - 是否存在
  */
@@ -54,11 +55,16 @@ export function pathExistsSync(filePath: string):boolean{
     }
 }
 
-/**创建路径 path.sep 结尾时创建文件夹 异步
+/**路径不存在时创建路径 以path.sep结尾时创建文件夹 异步
+ * @async
  * @param {string} filePath - 待创建的路径
+ * @param {boolean} isDir   - 强制创建一个文件夹
  * @returns {Promise<boolean>} - 是否成功创建
  */
-export async function createPath(filePath: string):Promise<boolean>{
+export async function createPath(filePath: string, isDir?:boolean):Promise<boolean>{
+    if(isDir==true)
+        filePath = path.join(filePath,path.sep);
+
     try{
         if(filePath.endsWith(path.sep)){
             await fs.promises.mkdir(filePath, {recursive: true});
@@ -75,11 +81,15 @@ export async function createPath(filePath: string):Promise<boolean>{
     }
 }
 
-/**创建路径 path.sep 结尾时创建文件夹 同步
+/**路径不存在时创建路径 以path.sep结尾时创建文件夹 同步
  * @param {string} filePath - 待创建的路径
+ * @param {boolean} isDir   - 强制验证一个文件夹
  * @returns {boolean} - 是否成功创建
  */
-export function createPathSync(filePath: string):boolean{
+export function createPathSync(filePath: string, isDir?:boolean):boolean{
+    if(isDir==true)
+        filePath = path.join(filePath,path.sep);
+
     try{
         if(filePath.endsWith(path.sep)){
             fs.mkdirSync(filePath, {recursive: true});
@@ -96,6 +106,28 @@ export function createPathSync(filePath: string):boolean{
     }
 }
 
+/**确保路径存在 不存在时创建 异步
+ * @async
+ * @param {string} filePath - 待验证的路径
+ * @param {boolean} isDir   - 强制验证一个文件夹
+ * @returns {Promise<boolean>} - 是否成功执行 创建或已存在
+ */
+export async function ensurePathExists(filePath: string, isDir?:boolean):Promise<boolean>{
+    if(await pathExists(filePath))
+        return true;
+    return await createPath(filePath,isDir);
+}
+
+/**确保路径存在 不存在时创建 同步
+ * @param {string} filePath - 待验证的路径
+ * @returns {boolean} - 是否成功执行 创建或已存在
+ */
+export function ensurePathExistsSync(filePath: string, isDir?:boolean):boolean{
+    if(pathExistsSync(filePath))
+        return true;
+    return createPathSync(filePath,isDir);
+}
+
 /**加载json文件 同步
  * Object (string)
  * @param {string} filePath - 文件路径