ph-utils 0.2.5 → 0.2.9

package/lib/date.js

@@ -100,10 +100,10 @@ function startOf(date, unit, isEnd = false) {
 exports.startOf = startOf;
 /**
  * 日期加上指定时间后的日期
- * @param date {Date | number | string | null}  指定的日期
- * @param num {number}  需要添加的数字, 如果这个参数传递一个小于0的数字，则就是日期减去相应的数字
- * @param unit {string}  需要添加的单位，date - 加减天数
- * @param fmt {string}   可选参数，如果传递了格式化的单位，则返回格式化后的日期, 格式化字符串 yyyy - 年, mm - 月, dd - 日, HH - 小时, MM - 分钟, ss - 秒
+ * @param date  指定的日期
+ * @param num   需要添加的数字, 如果这个参数传递一个小于0的数字，则就是日期减去相应的数字
+ * @param unit  需要添加的单位，date - 加减天数
+ * @param fmt   可选参数，如果传递了格式化的单位，则返回格式化后的日期, 格式化字符串 yyyy - 年, mm - 月, dd - 日, HH - 小时, MM - 分钟, ss - 秒
  * @returns {Date | string} 如果传递了 fmt 参数，则返回 string，否则返回 Date
  */
 function add(date, num, unit, fmt) {

package/lib/file.d.ts

@@ -24,5 +24,11 @@ declare const _default: {
      * @param done 遍历完成后的回调
      */
     traverseDir(dir: string, callback?: (filename: string) => void, done?: () => void): void;
+    /**
+     * 根据文件的 stat 获取文件的 etag
+     * @param filePath 文件地址
+     * @returns file stat etag
+     */
+    statTag(filePath: string): Promise<string>;
 };
 export = _default;

package/lib/file.js

@@ -71,7 +71,9 @@ module.exports = {
                             clearTimeout(t);
                             t = setTimeout(() => {
                                 setImmediate(() => {
-                                    done();
+                                    if (typeof done === 'function') {
+                                        done();
+                                    }
                                 });
                             }, 10);
                         }
@@ -85,4 +87,13 @@ module.exports = {
         }
         list(dir, callback, done);
     },
+    /**
+     * 根据文件的 stat 获取文件的 etag
+     * @param filePath 文件地址
+     * @returns file stat etag
+     */
+    async statTag(filePath) {
+        let stat = await fs.promises.stat(filePath);
+        return `${stat.size.toString(16)}-${stat.mtimeMs.toString(16)}`;
+    },
 };

package/lib/index.js

@@ -1,27 +1,23 @@
-"use strict";
 /**
  * node 和 web 通用的工具类
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseError = exports.isBoolean = exports.isNumeric = exports.shieldMobile = exports.isBlank = void 0;
 /**
  * 验证字符串是否为空
  * @param str               待验证的字符串
  * @param ignoreWhitespace  是否忽略空格(包括空白字符串以及[\r\t\n]之类的制表符)，默认为true
  */
-function isBlank(str, ignoreWhitespace = true) {
+export function isBlank(str, ignoreWhitespace = true) {
     if (str == null) {
         return true;
     }
     return (ignoreWhitespace ? str.trim().length : str.length) === 0;
 }
-exports.isBlank = isBlank;
 /**
  * 屏蔽手机号，中间部分用 * 展示
  * @param mobile 待屏蔽的手机号
  * @returns 屏蔽后的手机号，例如：123 **** 1234
  */
-function shieldMobile(mobile) {
+export function shieldMobile(mobile) {
     let x1 = Math.round(mobile.length / 2);
     let x2 = Math.round(x1 / 2);
     let shields = [' '];
@@ -31,7 +27,6 @@ function shieldMobile(mobile) {
     shields.push(' ');
     return mobile.substring(0, x2) + shields.join('') + mobile.substring(x2 + x1);
 }
-exports.shieldMobile = shieldMobile;
 /**
  * 验证参数是否是数字
  * @param str 待验证的字符串
@@ -40,26 +35,36 @@ exports.shieldMobile = shieldMobile;
  * @param numericParam.isFloat 是否是小数
  * @returns true 是数字, false 不是数字
  */
-function isNumeric(str, numericParam) {
+export function isNumeric(str, numericParam) {
     numericParam = { isPositive: false, isFloat: true, ...(numericParam || {}) };
     let symbol = numericParam.isPositive ? '[+]?' : '[+-]?';
     let main = numericParam.isFloat ? '([0-9]*[.])?[0-9]+' : '[0-9]+';
     return new RegExp('^' + symbol + main + '$').test(str);
 }
-exports.isNumeric = isNumeric;
 /**
  * 验证参数是否是Boolean 类型
  * @param str 待验证的字符串
  * @returns
  */
-function isBoolean(str) {
+export function isBoolean(str) {
     return ['true', 'false'].indexOf(str) >= 0;
 }
-exports.isBoolean = isBoolean;
 /**
  * 带有错误名称标记的错误类型
  */
-class BaseError extends Error {
+export class BaseError extends Error {
+    constructor() {
+        if (arguments.length === 1) {
+            super(arguments[0]);
+            this.name = 'BaseError';
+        }
+        else {
+            super(arguments[1]);
+            this.name = arguments[0];
+        }
+    }
+}
+ass BaseError extends Error {
     /**
      * 错误名称，类似于 Java 中的不同的 Exception[NullPointerException]；
      * 增加 name 字段，表明不同的错误，当需要根据不同的错误执行不同的处理的时候，会很有用

package/lib/server.js

@@ -59,7 +59,7 @@ module.exports = {
             options = { ...(options || {}) };
             const errorName = options.errorName || 'ExecError';
             delete options.errorName;
-            child_process_1.exec(cmd, options, (error, stdout, stderr) => {
+            (0, child_process_1.exec)(cmd, options, (error, stdout, stderr) => {
                 let err = null;
                 let rs = null;
                 if (error) {

package/lib/validator.d.ts

@@ -1,8 +1,20 @@
+/**
+ * 数据验证器
+ */
 interface RuleItem {
     rule: RegExp | ((v: any) => boolean);
     message: string;
     sameKey?: string;
 }
+export declare type RuleType = string | RegExp | ((v: any) => boolean) | (RegExp | string | ((v: any) => boolean) | {
+    rule: string | RegExp | ((v: any) => boolean);
+    message?: string;
+});
+export interface SchemaType {
+    key: string;
+    type?: string | ((v: any) => void);
+    rules: RuleType[];
+}
 /**
  * 数据验证器，除了进行数据验证外，还可以同时进行数据转化
  */
@@ -17,14 +29,7 @@ declare class Validator {
      * 构造数据验证转换器
      * @param schemas 配置验证转换规则
      */
-    constructor(schemas: {
-        key: string;
-        type?: string | ((v: any) => void);
-        rules: string | RegExp | ((v: any) => boolean) | (RegExp | string | ((v: any) => boolean) | {
-            rule: string | RegExp | ((v: any) => boolean);
-            message?: string;
-        })[];
-    }[]);
+    constructor(schemas: SchemaType[]);
     /**
      * 进行数据验证，同时根据 type 进行数据类型转换
      * @param data 待验证的数据

package/lib/validator_m.d.ts

@@ -1,8 +1,20 @@
+/**
+ * 数据验证器
+ */
 interface RuleItem {
     rule: RegExp | ((v: any) => boolean);
     message: string;
     sameKey?: string;
 }
+export declare type RuleType = string | RegExp | ((v: any) => boolean) | (RegExp | string | ((v: any) => boolean) | {
+    rule: string | RegExp | ((v: any) => boolean);
+    message?: string;
+});
+export interface SchemaType {
+    key: string;
+    type?: string | ((v: any) => void);
+    rules: RuleType[];
+}
 /**
  * 数据验证器，除了进行数据验证外，还可以同时进行数据转化
  */
@@ -17,14 +29,7 @@ declare class Validator {
      * 构造数据验证转换器
      * @param schemas 配置验证转换规则
      */
-    constructor(schemas: {
-        key: string;
-        type?: string | ((v: any) => void);
-        rules: string | RegExp | ((v: any) => boolean) | (RegExp | string | ((v: any) => boolean) | {
-            rule: string | RegExp | ((v: any) => boolean);
-            message?: string;
-        })[];
-    }[]);
+    constructor(schemas: SchemaType[]);
     /**
      * 进行数据验证，同时根据 type 进行数据类型转换
      * @param data 待验证的数据

package/lib/validator_m.js

@@ -216,4 +216,5 @@ class Validator {
         return rules;
     }
 }
+// @ts-ignore
 export default Validator;

package/package.json

@@ -5,7 +5,7 @@
   "module": "lib/index_m.js",
   "types": "lib/index.d.ts",
   "browser": "lib/index_m.js",
-  "version": "0.2.5",
+  "version": "0.2.9",
   "repository": {
     "type": "git",
     "url": "git+https//gitee.com/towardly/ph.git",
@@ -19,7 +19,7 @@
   "homepage": "https://gitee.com/towardly/ph/tree/master/packages/utils",
   "devDependencies": {
     "@types/node": "^17.0.21",
-    "typescript": "^4.5.5"
+    "typescript": "4.5.5"
   },
   "scripts": {
     "build": "node scripts/build.js"