ph-utils 0.2.22 → 0.3.0

package/lib/index.d.ts

@@ -1,61 +1,97 @@
-/**
- * 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;
+/**
+ * 验证字符串是否为空
+ * @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;
+/** 生成随机数的选项 */
+interface RandomConfig {
+    /** 生成指定长度的随机字符串 */
+    length?: number;
+    /** 是否包含英文字母, 默认为: true */
+    hasLetter?: boolean;
+    /** 生成纯数字的随机数时, 首位是否允许为 0, 默认为: true */
+    firstIsZero?: boolean;
+    /** 配合 max 生成 [min~max] 之间的随机数 */
+    min?: number;
+    /** 配合 min 生成 [min~max] 之间的随机数 */
+    max?: number;
+    /** 生成的随机数，是否包含 max, 默认: false */
+    hasEnd?: boolean;
+    /** 生成的随机数是否是整数, 默认: true */
+    isInteger?: boolean;
+}
+/**
+ * 生成随机数
+ *  1. 生成指定长度的随机数
+ *  2. 生成介于 [min, max] 之间的随机数
+ * @param opts 生成随机数的配置
+ * @returns
+ */
+export declare function random(opts: number | RandomConfig): string | number;
+/**
+ * 带有错误名称标记的错误类型
+ */
+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);
+}
+/**
+ * 函数节流 - 每隔单位时间，只执行一次
+ * @param cb    待节流的函数
+ * @param wait  间隔时间
+ * @returns
+ */
+export declare function throttle<R extends any[], T>(fn: (...args: R) => T, wait?: number): (...args: R) => void;
+/**
+ * 函数防抖 - 当重复触发某一个行为（事件时），只执行最后一次触发
+ * @param fn        防抖函数
+ * @param interval  间隔时间段
+ * @returns
+ */
+export declare function debounce<R extends any[], T>(fn: (...args: R) => T, interval?: number): (...args: R) => void;
+/**
+ * 将金额数字格式化为金额格式显示并且会保留两位小数[去除多余的位数，不是四舍五入，而是直接舍去]  1234523432.23 => 123,123,123.23
+ * @param {number} number 待转换的金额数字
+ * @return string
+ */
+export declare function formatMoney(number: number): string;
+export {};

package/lib/index.js

@@ -1,82 +1,171 @@
-/**
- * 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);
-    };
-}
+/**
+ * node 和 web 通用的工具类
+ */
+/** 包含字母+数字的随机数字符 */
+const RANDOM_CHARS = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
+/** 只包含字母的随机数字符 */
+const NUMBER_RANDOM_CHARTS = '0123456789';
+/**
+ * 验证字符串是否为空
+ * @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;
+}
+/**
+ * 生成随机数
+ *  1. 生成指定长度的随机数
+ *  2. 生成介于 [min, max] 之间的随机数
+ * @param opts 生成随机数的配置
+ * @returns
+ */
+export function random(opts) {
+    if (typeof opts === 'object' && opts.min != null && opts.max != null) {
+        const randomNum = Math.random();
+        /* 生成两个数字之间的随机数(number) */
+        const end = opts.hasEnd ? 1 : 0;
+        const resRandom = randomNum * (opts.max - opts.min + end) + opts.min;
+        return opts.isInteger !== false ? Math.floor(resRandom) : resRandom;
+    }
+    else {
+        if (typeof opts === 'object' && opts.length == null) {
+            throw new Error('random_length_cannot_null');
+        }
+        const len = typeof opts === 'object' ? opts.length : opts;
+        /* 生成指定长度的随机数 */
+        const charLens = RANDOM_CHARS.length;
+        let chars = RANDOM_CHARS;
+        if (typeof opts === 'object' && opts.hasLetter === false) {
+            chars = NUMBER_RANDOM_CHARTS;
+        }
+        const resRandom = Array.from({ length: len }, () => chars.charAt(Math.floor(Math.random() * charLens))).join('');
+        if (typeof opts === 'object' && opts.firstIsZero === false && resRandom.indexOf('0') === 0) {
+            return random(opts);
+        }
+        else {
+            return resRandom;
+        }
+    }
+}
+/**
+ * 带有错误名称标记的错误类型
+ */
+export class BaseError extends Error {
+    /**
+     * 错误名称，类似于 Java 中的不同的 Exception[NullPointerException]；
+     * 增加 name 字段，表明不同的错误，当需要根据不同的错误执行不同的处理的时候，会很有用
+     */
+    name;
+    constructor() {
+        if (arguments.length === 1) {
+            super(arguments[0]);
+            this.name = 'BaseError';
+        }
+        else {
+            super(arguments[1]);
+            this.name = arguments[0];
+        }
+    }
+}
+/**
+ * 函数节流 - 每隔单位时间，只执行一次
+ * @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);
+    };
+}
+/**
+ * 将金额数字格式化为金额格式显示并且会保留两位小数[去除多余的位数，不是四舍五入，而是直接舍去]  1234523432.23 => 123,123,123.23
+ * @param {number} number 待转换的金额数字
+ * @return string
+ */
+export function formatMoney(number) {
+    if (typeof Intl.NumberFormat !== 'undefined') {
+        const formatter = new Intl.NumberFormat('zh-CN', {
+            style: 'decimal',
+            maximumFractionDigits: 2,
+        });
+        return formatter.format(number);
+    }
+    else {
+        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);
+    }
+}

package/lib/server.d.ts

@@ -1,39 +1,32 @@
-/// <reference types="node" />
-import { ExecOptions } from 'child_process';
-interface ExecPromiseOptions {
-    /** 执行失败后的错误信息添加 name 属性标记 */
-    errorName?: string;
-}
-declare const _default: {
-    /**
-     * 进行 MD5 加密
-     * @param {String} data 待加密的数据
-     */
-    md5(data: string): string;
-    /**
-     * 生成随机数：
-     *  1. 生成指定长度的随机字符串(包含字母), 传递的第二个参数为 boolean 类型；如果想实现纯数字的，可以考虑通过 min - max 的形式，例如：
-     *
-     *    a. 生成 4 位长度纯数字(首位不包含0)：random(1000, 10000)
-     *
-     *    b. 生成 4 位长度(首位可以包含0)：random(0, 10) + random(1000, 10000)
-     *
-     *    c. 生成 4 位长度(首位可以包含0，使用 Math.random()实现)，具体实现可以参考该工具类的 web 端的 random 代码
-     *
-     *  2. 生成 [min, max) 之间的随机数字(**整形**)，传递的第二个参数为 number 类型，如果想要生成包含 max 的传递参数的时候，手动将 max + 1 即可
-     * @param minOrLen 如果第二个参数为 number 类型，则表示 min，生成 [min,max) 之间的随机数，返回值类型为 int;
-     *    如果第二个参数为 boolean 类型，则表示 len，生成的随机数的长度
-     * @param maxOrUpper 如果类型为 number 类型则表示 max，生成 [min,max) 之间的随机数，返回值类型为 int;
-     *    如果类型为 boolean 类型则表示 upper，生成指定长度(len)的随机字符串(包含字母)，true - 返回大写, 默认为 false
-     */
-    random(minOrLen: number, maxOrUpper: number | boolean): string | number;
-    /**
-     * exec Promise 版本
-     * @param cmd 命令名称
-     * @param options 命令参数，基于 exec-options 基础上，增加 errorName 字段
-     */
-    execPromise(cmd: string, options?: ExecPromiseOptions & {
-        encoding?: BufferEncoding;
-    } & ExecOptions): Promise<unknown>;
-};
-export = _default;
+/**
+ * 执行命令
+ * @param cmd 执行的命令
+ * @returns
+ */
+export declare function exec(cmd: string): Promise<string>;
+interface SpawnCmdOptions {
+    /** 命令运行目录 */
+    cwd?: string;
+    /** 每一行的输出 */
+    data?: (lineText?: string) => void;
+    /** 错误输出 */
+    error?: (err: Error) => void;
+    /** 最终结果 */
+    finally?: (err?: Error) => void;
+}
+/**
+ * 执行 spawn 命令
+ * @param command 执行的命令: 例如: git
+ * @param args    命令参数: ['clone', 'https://xxxx.git']
+ * @param options 参数
+ */
+export declare function spawnCmd(command: string, args?: string[], options?: SpawnCmdOptions): void;
+/**
+ * 执行 spawn 命令
+ * @param command 执行的命令: 例如: git
+ * @param args    命令参数: ['clone', 'https://xxxx.git']
+ * @param options 参数
+ * @returns
+ */
+export declare function spawnPromise(command: string, args?: string[], options?: SpawnCmdOptions): Promise<unknown>;
+export {};