ph-utils 0.2.23 → 0.3.0

package/lib/web.js

@@ -1,141 +1,57 @@
-/**
- * web(浏览器) 端工具类
- */
-import { isBlank } from './index_m';
-/**
- * 解析 Form 表单中的 input 元素的数据为 JSON 格式，key: input-name；value: input-value
- * @param form {object} Form 节点对象
- */
-export const formJson = function (form) {
-    let elems = form.elements;
-    let value = {};
-    for (let i = 0, len = elems.length; i < len; i++) {
-        let item = elems[i];
-        if (!isBlank(item.name)) {
-            if ((item.tagName === 'INPUT' || item.tagName === 'TEXTAREA') &&
-                !isBlank(item.value)) {
-                let dataType = item.getAttribute('data-type');
-                if (dataType === 'number') {
-                    value[item.name] = Number(item.value);
-                }
-                else {
-                    value[item.name] = item.value;
-                }
-            }
-            else if (item.tagName === 'SELECT') {
-                value[item.name] = item.options[item.selectedIndex].value;
-            }
-        }
-    }
-    return value;
-};
-/**
- * 获取 url query 参数 (get 请求的参数)
- * @param search 如果是 React 应用就需要传递 useLocation().search
- * @returns
- */
-export function query(search) {
-    if (isBlank(search)) {
-        search = location.search;
-    }
-    const searchParams = new URLSearchParams(search);
-    let query = {};
-    for (const [key, value] of searchParams) {
-        let oldValue = query[key];
-        let newValue = value;
-        if (oldValue != null) {
-            if (oldValue instanceof Array) {
-                oldValue.push(value);
-                newValue = oldValue;
-            }
-            else {
-                newValue = [value, oldValue];
-            }
-        }
-        query[key] = newValue;
-    }
-    return query;
-}
-export function random() {
-    let r = Math.random();
-    const startOrLen = arguments[0];
-    let endOrFirstZero = arguments[1];
-    if (typeof endOrFirstZero === 'number') {
-        /* 生成两个数字之间的随机数(number) */
-        let opts = arguments[3];
-        const dftOpts = { isInt: true };
-        opts = Object.assign(dftOpts, opts || {});
-        const e = opts.isInt && opts.hasEnd ? 1 : 0;
-        const rs = r * (endOrFirstZero - startOrLen + e) + startOrLen;
-        return opts.isInt ? parseInt(rs, 10) : rs;
-    }
-    endOrFirstZero = endOrFirstZero || true;
-    if (endOrFirstZero) {
-        // 生成的数字包含前面的0
-        r = r.toString();
-        return r.substr(r.indexOf('.') + 1, startOrLen);
-    }
-    const max = Math.pow(10, startOrLen - 1);
-    r = parseInt(String(r * max), 10);
-    if (r < max) {
-        // 生成的随机数前置有0，重新生成随机数
-        return random(startOrLen, endOrFirstZero);
-    }
-    return r;
-}
-/**
- * 将金额数字格式化为金额格式显示并且会保留两位小数[去除多余的位数，不是四舍五入，而是直接舍去]  1234523432.23 => 123,123,123.23
- * @param {number} number 待转换的金额数字
- * @return string
- */
-export function formatMoney(number) {
-    number = number || 0;
-    let negative = '';
-    let base = String(parseInt(number, 10)); // 获取数字整数部分
-    let mod = base.length > 3 ? base.length % 3 : 0;
-    /*
-     * 利用 正则前瞻 (?=) 将3位数字后面还紧跟一位数字的三位数字替换为 数字, 的形式
-     */
-    let numberStr = String(number);
-    let usePrecision = numberStr.indexOf('.');
-    let dotStr = usePrecision > 0 ? numberStr.slice(usePrecision + 1) : '00';
-    dotStr = dotStr.length > 2 ? dotStr.slice(0, 2) : dotStr;
-    return (negative +
-        (mod ? base.slice(0, mod) + ',' : '') +
-        base.slice(mod).replace(/(\d{3})(?=\d)/g, '$1,') +
-        '.' +
-        dotStr);
-}
-/**
- * 函数节流 - 每隔单位时间，只执行一次
- * @param cb    待节流的函数
- * @param wait  间隔时间
- * @returns
- */
-export function throttle(fn, wait = 500) {
-    // 上一次的请求时间
-    let last = 0;
-    return (...args) => {
-        // 当前时间戳
-        const now = Date.now();
-        if (now - last > wait) {
-            fn(...args);
-            last = now;
-        }
-    };
-}
-/**
- * 函数防抖 - 当重复触发某一个行为（事件时），只执行最后一次触发
- * @param fn        防抖函数
- * @param interval  间隔时间段
- * @returns
- */
-export function debounce(fn, interval = 500) {
-    let _t = -1;
-    return (...args) => {
-        clearTimeout(_t);
-        _t = setTimeout(() => {
-            fn(...args);
-        }, interval);
-    };
-}
+/**
+ * web(浏览器) 端工具类
+ */
+import { isBlank } from './index';
+/**
+ * 解析 Form 表单中的 input 元素的数据为 JSON 格式，key: input-name；value: input-value
+ * @param form {object} Form 节点对象
+ */
+export const formJson = function (form) {
+    let elems = form.elements;
+    let value = {};
+    for (let i = 0, len = elems.length; i < len; i++) {
+        let item = elems[i];
+        if (!isBlank(item.name)) {
+            if ((item.tagName === 'INPUT' || item.tagName === 'TEXTAREA') && !isBlank(item.value)) {
+                let dataType = item.getAttribute('data-type');
+                if (dataType === 'number') {
+                    value[item.name] = Number(item.value);
+                }
+                else {
+                    value[item.name] = item.value;
+                }
+            }
+            else if (item.tagName === 'SELECT') {
+                value[item.name] = item.options[item.selectedIndex].value;
+            }
+        }
+    }
+    return value;
+};
+/**
+ * 获取 url query 参数 (get 请求的参数)
+ * @param search 如果是 React 应用就需要传递 useLocation().search
+ * @returns
+ */
+export function query(search) {
+    if (isBlank(search)) {
+        search = location.search;
+    }
+    const searchParams = new URLSearchParams(search);
+    let query = {};
+    for (const [key, value] of searchParams) {
+        let oldValue = query[key];
+        let newValue = value;
+        if (oldValue != null) {
+            if (oldValue instanceof Array) {
+                oldValue.push(value);
+                newValue = oldValue;
+            }
+            else {
+                newValue = [value, oldValue];
+            }
+        }
+        query[key] = newValue;
+    }
+    return query;
+}

package/package.json

@@ -2,10 +2,11 @@
   "name": "ph-utils",
   "description": "js 开发工具集，前后端都可以使用(commonjs和es module)",
   "main": "lib/index.js",
-  "module": "lib/index_m.js",
+  "module": "lib/index.js",
   "types": "lib/index.d.ts",
-  "browser": "lib/index_m.js",
-  "version": "0.2.23",
+  "browser": "lib/index.js",
+  "version": "0.3.0",
+  "type": "module",
   "repository": {
     "type": "git",
     "url": "git+https//gitee.com/towardly/ph.git",
@@ -18,11 +19,8 @@
   },
   "homepage": "https://gitee.com/towardly/ph/tree/master/packages/utils",
   "devDependencies": {
-    "@types/node": "^17.0.21",
-    "typescript": "4.5.5"
-  },
-  "scripts": {
-    "build": "node scripts/build.js"
+    "@types/node": "^20.3.1",
+    "typescript": "^5.1.3"
   },
   "files": [
     "lib"
@@ -34,5 +32,8 @@
     "date",
     "dom",
     "file"
-  ]
+  ],
+  "scripts": {
+    "build": "node scripts/build.js"
+  }
 }

package/lib/date_m.d.ts

@@ -1,34 +0,0 @@
-/**
- * 将日期格式化为指定形式的字符串
- * @param date      日期
- * @param pattern   格式化字符串 yyyy - 年, mm - 月, dd - 日, HH - 小时, MM - 分钟, ss - 秒
- */
-export declare function format(date?: Date | string | number, pattern?: string): string;
-/**
- * 将指定的参数解析为日期对象(Date)
- * 参考 dayjs 实现, 也可以参考 https://github.com/nomiddlename/date-format
- * @param date 待解析的日期参数
- */
-export declare function parse(date?: Date | string | number): Date;
-/**
- * 设置日期的开始或者结束的点
- * @param {Object} date 日期，能够被 parse 解析的日期
- * @param {String} unit 单位，H Hours, 默认为 H
- * @param {Boolean} isEnd true则为 endOf
- */
-export declare function startOf(date?: Date | string | number, unit?: string, isEnd?: boolean): Date;
-/**
- * 日期加上指定时间后的日期
- * @param date 指定的日期
- * @param num  需要添加的数字, 如果这个参数传递一个小于0的数字，则就是日期减去相应的数字
- * @param unit 需要添加的单位，date - 加减天数
- */
-export declare function add(date: Date | string | number | null, num: number, unit: string): Date;
-/**
- * 日期加上指定时间后的日期
- * @param date    指定的日期, 传递为 null ，则表示为当前日期
- * @param num     需要添加的数字, 如果这个参数传递一个小于0的数字，则就是日期减去相应的数字
- * @param unit    需要添加的单位，date - 加减天数
- * @param fmt     如果传递了格式化的单位，则返回格式化后的日期, 格式化字符串 yyyy - 年, mm - 月, dd - 日, HH - 小时, MM - 分钟, ss - 秒
- */
-export declare function add(date: Date | string | number | null, num: number, unit: string, fmt: string): string;

package/lib/date_m.js

@@ -1,119 +0,0 @@
-/**
- * node 和 web 端日期处理工具类
- */
-// 配置日期格式的正则表达式
-const REGEX_FORMAT = /yy(?:yy)?|([HMmds])\1?/g;
-// 由于 Date.parse() 不能正确解析 yyyy-dd-mm 格式的日期, 所以匹配手动解析
-const REGEX_PARSE = /^(\d{4})-?(\d{1,2})-?(\d{0,2})[^0-9]*(\d{1,2})?:?(\d{1,2})?:?(\d{1,2})?.?(\d{1,3})?$/;
-/**
- * 不足位数, 前位补 0
- * @param s 日期数字
- * @param l 截取位数
- * @returns {string}  补0后的日期数字
- */
-function p(s, l = 2) {
-    /*
-     * 由于年份最多为4为，所以前面先添3个0
-     * slice() 从后开始提前字符串
-     */
-    return ('000' + s).slice(l * -1);
-}
-function getUnit(unit) {
-    return unit.substring(0, 1).toUpperCase() + unit.substring(1);
-}
-/**
- * 将日期格式化为指定形式的字符串
- * @param date      日期
- * @param pattern   格式化字符串 yyyy - 年, mm - 月, dd - 日, HH - 小时, MM - 分钟, ss - 秒
- */
-export function format(date, pattern = 'yyyy-mm-dd HH:MM') {
-    date = parse(date);
-    let d = date.getDate();
-    let y = date.getFullYear();
-    let m = date.getMonth();
-    let H = date.getHours();
-    let M = date.getMinutes();
-    let s = date.getSeconds();
-    let flags = {
-        yy: p(y),
-        yyyy: y,
-        m: m + 1,
-        mm: p(m + 1),
-        d: d,
-        dd: p(d),
-        H: H,
-        HH: p(H),
-        M: M,
-        MM: p(M),
-        s: s,
-        ss: p(s),
-    };
-    if (pattern != null) {
-        return pattern.replace(REGEX_FORMAT, (flag) => {
-            if (flag in flags) {
-                return flags[flag];
-            }
-            return flag;
-        });
-    }
-    return String(date.getTime());
-}
-/**
- * 将指定的参数解析为日期对象(Date)
- * 参考 dayjs 实现, 也可以参考 https://github.com/nomiddlename/date-format
- * @param date 待解析的日期参数
- */
-export function parse(date) {
-    if (date == null)
-        return new Date();
-    if (date instanceof Date)
-        return date;
-    if (typeof date === 'string' && !/Z$/i.test(date)) {
-        const d = date.match(REGEX_PARSE);
-        if (d) {
-            return new Date(d[1], d[2] - 1, d[3] || 1, d[4] || 0, d[5] || 0, d[6] || 0, d[7] || 0);
-        }
-    }
-    return new Date(date);
-}
-/**
- * 设置日期的开始或者结束的点
- * @param {Object} date 日期，能够被 parse 解析的日期
- * @param {String} unit 单位，H Hours, 默认为 H
- * @param {Boolean} isEnd true则为 endOf
- */
-export function startOf(date, unit, isEnd = false) {
-    const argumentStart = [0, 0, 0, 0];
-    const argumentEnd = [23, 59, 59, 999];
-    date = parse(date);
-    let u = getUnit(unit || 'Hours');
-    let fn = 'set' + u;
-    let args = isEnd === true ? argumentEnd : argumentStart;
-    Date.prototype[fn].apply(date, args);
-    return date;
-}
-/**
- * 日期加上指定时间后的日期
- * @param date  指定的日期
- * @param num   需要添加的数字, 如果这个参数传递一个小于0的数字，则就是日期减去相应的数字
- * @param unit  需要添加的单位，date - 加减天数
- * @param fmt   可选参数，如果传递了格式化的单位，则返回格式化后的日期, 格式化字符串 yyyy - 年, mm - 月, dd - 日, HH - 小时, MM - 分钟, ss - 秒
- * @returns {Date | string} 如果传递了 fmt 参数，则返回 string，否则返回 Date
- */
-export function add(date, num, unit, fmt) {
-    let sdate = new Date();
-    if (date != null) {
-        sdate = parse(date);
-    }
-    unit = getUnit(unit);
-    let fn = 'set' + unit;
-    let gn = 'get' + unit;
-    let oldValue = Date.prototype[gn].apply(sdate);
-    Date.prototype[fn].apply(sdate, [oldValue + num]);
-    if (typeof fmt === 'string') {
-        return format(sdate, fmt);
-    }
-    else {
-        return sdate;
-    }
-}

package/lib/index_m.d.ts

@@ -1,61 +0,0 @@
-/**
- * node 和 web 通用的工具类
- */
-/**
- * 验证字符串是否为空
- * @param str               待验证的字符串
- * @param ignoreWhitespace  是否忽略空格(包括空白字符串以及[\r\t\n]之类的制表符)，默认为true
- */
-export declare function isBlank(str?: string | null, ignoreWhitespace?: boolean): boolean;
-/**
- * 屏蔽手机号，中间部分用 * 展示
- * @param mobile 待屏蔽的手机号
- * @returns 屏蔽后的手机号，例如：123 **** 1234
- */
-export declare function shieldMobile(mobile: string): string;
-/**
- * 验证参数是否是数字
- * @param str 待验证的字符串
- * @param numericParam 通过参数标记是否包含小数、正数
- * @param numericParam.isPositive 是否是正数
- * @param numericParam.isFloat 是否是小数
- * @returns true 是数字, false 不是数字
- */
-export declare function isNumeric(str: string, numericParam?: {
-    isPositive?: boolean;
-    isFloat?: boolean;
-}): boolean;
-/**
- * 验证参数是否是Boolean 类型
- * @param str 待验证的字符串
- * @returns
- */
-export declare function isBoolean(str: string): boolean;
-/**
- * 带有错误名称标记的错误类型
- */
-export declare class BaseError extends Error {
-    /**
-     * 错误名称，类似于 Java 中的不同的 Exception[NullPointerException]；
-     * 增加 name 字段，表明不同的错误，当需要根据不同的错误执行不同的处理的时候，会很有用
-     */
-    name: string;
-    /**
-     * 构造一个 name = BaseError 的错误信息
-     * @param message 错误描述
-     */
-    constructor(message: string);
-    /**
-     *
-     * @param name 错误名称
-     * @param message 错误描述
-     */
-    constructor(name: string, message: string);
-}
-/**
- * 创建一个节流函数，在 wait 秒内最多执行 func 一次的函数。
- * @param func 要节流的函数
- * @param wait 需要节流的毫秒
- * @returns
- */
-export declare function throttle<T extends (...args: any) => any>(func: T, wait?: number): (...args: any[]) => void;

package/lib/index_m.js

@@ -1,82 +0,0 @@
-/**
- * node 和 web 通用的工具类
- */
-/**
- * 验证字符串是否为空
- * @param str               待验证的字符串
- * @param ignoreWhitespace  是否忽略空格(包括空白字符串以及[\r\t\n]之类的制表符)，默认为true
- */
-export function isBlank(str, ignoreWhitespace = true) {
-    if (str == null) {
-        return true;
-    }
-    return (ignoreWhitespace ? str.trim().length : str.length) === 0;
-}
-/**
- * 屏蔽手机号，中间部分用 * 展示
- * @param mobile 待屏蔽的手机号
- * @returns 屏蔽后的手机号，例如：123 **** 1234
- */
-export function shieldMobile(mobile) {
-    let x1 = Math.floor(mobile.length / 2);
-    let x2 = Math.ceil(x1 / 2);
-    let shields = [' '];
-    for (let i = 0; i < x1 - 1; i++) {
-        shields.push('*');
-    }
-    shields.push(' ');
-    return (mobile.substring(0, x2) + shields.join('') + mobile.substring(x2 + x1 - 1));
-}
-/**
- * 验证参数是否是数字
- * @param str 待验证的字符串
- * @param numericParam 通过参数标记是否包含小数、正数
- * @param numericParam.isPositive 是否是正数
- * @param numericParam.isFloat 是否是小数
- * @returns true 是数字, false 不是数字
- */
-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);
-}
-/**
- * 验证参数是否是Boolean 类型
- * @param str 待验证的字符串
- * @returns
- */
-export function isBoolean(str) {
-    return ['true', 'false'].indexOf(str) >= 0;
-}
-/**
- * 带有错误名称标记的错误类型
- */
-export class BaseError extends Error {
-    constructor() {
-        if (arguments.length === 1) {
-            super(arguments[0]);
-            this.name = 'BaseError';
-        }
-        else {
-            super(arguments[1]);
-            this.name = arguments[0];
-        }
-    }
-}
-/**
- * 创建一个节流函数，在 wait 秒内最多执行 func 一次的函数。
- * @param func 要节流的函数
- * @param wait 需要节流的毫秒
- * @returns
- */
-export function throttle(func, wait = 300) {
-    let t = -1;
-    return function (...args) {
-        const self = this;
-        clearTimeout(t);
-        t = setTimeout(() => {
-            func.apply(self, args);
-        }, wait);
-    };
-}

package/lib/validator_m.d.ts

@@ -1,47 +0,0 @@
-/**
- * 数据验证器
- */
-interface RuleItem {
-    rule: RegExp | ((v: any) => boolean) | 'required';
-    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;
-    required?: boolean;
-    type?: string | ((v: any) => void);
-    rules: RuleType[];
-    message?: string;
-}
-/**
- * 数据验证器，除了进行数据验证外，还可以同时进行数据转化
- */
-declare class Validator {
-    rules: {
-        [index: string]: RuleItem[];
-    };
-    /**
-     * 构造数据验证转换器
-     * @param schemas 配置验证转换规则
-     */
-    constructor(schemas: SchemaType[]);
-    /**
-     * 进行数据验证
-     * @param data 待验证的数据
-     * @returns
-     */
-    validate(data: any): Promise<boolean>;
-    /**
-     * 只验证指定 key 的数据格式
-     * @param key   指定待验证的 key
-     * @param value 待验证的数据
-     */
-    validateKey(key: string, value: any, data?: any): Promise<boolean>;
-    private _validateRule;
-    private _parseStringRule;
-}
-export default Validator;