gzjs-utils 1.0.25 → 1.0.26

package/types/utils/Utils.d.ts

@@ -20,7 +20,7 @@ declare type TrimMode = 0 | 1 | 2;
 export type URLParam = string | number | boolean | any;
 export type QueryParams = {
     [key: string]: string | boolean | any | "";
-};
+} & Record<any, any>;
 export type URI = {
     "source": string | "";
     "protocol": string | "";
@@ -40,270 +40,438 @@ export type URI = {
     "hash": string | "";
     "params": QueryParams;
     toURLString: () => string;
+    hashInfo: {
+        params: QueryParams;
+        toString: () => string;
+    };
 };
 export type RandomTypeOrSource = 1 | 2 | 3 | (number | string)[] | string;
-export declare type Utils = {
+export declare const TRUE_FLAG: readonly (string | number | boolean)[];
+export declare const FALSE_FLAG: readonly (string | number | boolean)[];
+export declare const type: (obj: any) => any;
+export declare const isFunction: (obj: any) => boolean;
+export declare const isBase64: (str: any) => boolean;
+export declare const trim: (s: any) => any;
+export declare const parseUri: (str: any, strictMode?: boolean) => URI;
+export declare const parseQuery: (query: string) => QueryParams;
+export declare const getQueryParams: (search?: string, allowFromLocation?: boolean) => QueryParams;
+/**
+ * 随机生成UUID
+ * @param len 长度
+ */
+export declare function uuid(len: number): string;
+export declare function isArrayLike(obj: any): boolean;
+export declare function isArray(obj: any): boolean;
+export declare function shuffle<T>(arr: any): any;
+/**
+ * 获取随机数, 默认 字母+数组
+ * @param len 随机数长度
+ * @param typeOrSource 随机数类型：1=字母+数字， 2=数字 ， 3=字母,或者自定义数据源
+ */
+export declare function random(len?: number, typeOrSource?: RandomTypeOrSource): string;
+declare const _Utils_: {
     /**
-     * 获取对象类型；
-     * <p>
-     * 例如：
-     * <pre>
-     *     // type('123') 则返回 String
-     *     // type(133) 则返回 Number
-     *     // type([]) 则返回 Array
-     *     // type() 则返回 Undefined
-     *     // type(null) 则返回 null
-     * </pre>
-     *
-     * @param obj
+     * 获取字符串中包含的中文个数
+     * @param obj 字符串
+     * @returns 中文字符的数量
      */
-    type(obj: any): string;
+    chineseLen(obj: any_str): number;
     /**
-     * 是否为 String 类型
-     * @param obj
+     * 从身份证获取年龄（年、月、日）
+     * @param str 身份证号码
+     * @returns 返回 [年份, 月数, 天数] 数组，如果身份证无效则返回空数组
      */
-    isString(obj: any): boolean;
+    getAgeFromIDcard(str: string): [year, moth, day] | [];
     /**
-     * 判断对象是否为 函数类型
-     * @param obj
+     * 获取查询参数
+     * @param search 查询参数字符串，如果为空则从 URL 读取
+     * @param allowFromLocation 是否允许从 location 上获取，默认为 true
+     * @returns 查询参数对象
      */
-    isFunction(obj: any): boolean;
+    getQueryParams: (search?: string, allowFromLocation?: boolean) => QueryParams;
     /**
-     * 获取字符串中包含的中文个数
-     * @param obj
+     * 获取 URL 路径中的指定参数
+     * @param url URL 字符串
+     * @param key 参数名
+     * @returns 参数值
      */
-    chineseLen(obj: any_str): number;
+    getUrlParam(url: string, key: string): URLParam;
     /**
-     * 将字符串去空白
-     * @param str
-     * @param flag
+     * 获取 URL 路径中的所有参数
+     * @param url URL 字符串
+     * @returns 查询参数对象
      */
-    trim<T = any_str>(str: T, flag?: TrimMode): T;
+    getUrlParams(url: string): QueryParams;
     /**
-     * 去除 左边内容
-     * @param str 去除的内容
-     * @param prefix 左边内容
+     * 从 HTTP 响应中获取文件名
+     * @param source 数据源，支持以下格式：
+     *   - string: Content-Disposition 响应头内容
+     *   - Headers: Fetch API 的 Headers 对象
+     *   - Response: Fetch API 的 Response 对象
+     *   - XMLHttpRequest: XHR 对象
+     * @param headerName 可选，指定响应头名称，默认为 'Content-Disposition'
+     * @returns 文件名，如果解析失败则返回 null
      */
-    trimLeft<T = any_str>(str: T, prefix?: string): T;
+    getFileNameFromResponse(source: string | Headers | Response | XMLHttpRequest | any, headerName?: string): string;
     /**
-     * 去除 右边内容
-     * @param str 去除的内容
-     * @param suffix 右边内容
+     * 判断是否是安卓设备
+     * @returns 如果是安卓设备返回 true，否则返回 false
      */
-    trimRight<T = any_str>(str: T, suffix?: string): T;
+    isAndroid(): boolean;
     /**
-     * 最忌打乱数组顺序
-     * @param arr
+     * 是否为数组类型
+     * @param obj 待检测的对象
+     * @returns 如果是数组类型返回 true，否则返回 false
      */
-    shuffle<T>(arr: T[] | any): T[] | any;
+    isArray: typeof isArray;
     /**
-     * 生成UUID
+     * 判断是否为空，支持对象、字符串、Map、Set、Array 等
+     * @param obj 待检测的对象
+     * @returns 如果为空返回 true，否则返回 false
      */
-    uuid(): string;
+    isEmpty(obj: any): boolean;
     /**
-     * 随机生成
+     * 判断是否为空白字符串
+     * @param str 待检测的字符串
+     * @returns 如果为空白字符串（null、undefined、空字符串或纯空白字符）返回 true
      */
-    random: typeof random;
+    isBlank(str: any): boolean;
     /**
-     * 数据进行分页
-     * <pre>
-     *    // pageNo,从1开始， 如果指定 分页页码返回指定页码 的数据，默认返回全部数据
-     *    page([1,2,3,4,5,6,7,8,9,10], 3) // 返回 [[1,2,3],[4,5,6],[7,8,9],[10]]
-     *    page([1,2,3,4,5,6,7,8,9,10], 3, 3) // 返回 [[7,8,9]]
-     * </pre>
-     * @param arr 数据列表
-     * @param pageSize 分页大小
-     * @param pageNo 获取第几页的数据,从1开始，默认返回全部数据，如果指定 分页页码返回指定页码 的数据，
+     * 是否为 Base64 编码字符串
+     * @param str 待检测的字符串
+     * @returns 如果是 Base64 编码返回 true，否则返回 false
      */
-    page<T = any>(arr: T[], pageSize: number, pageNo?: number): T[][];
+    isBase64: (str: any) => boolean;
     /**
-     * 获取 URL 路径中的参数
-     * @param url
-     * @param key
+     * 是否为 Base64 图片格式
+     * @param str 待检测的字符串，格式如：data:image/png;base64,iVBORw0KGgo******
+     * @returns 如果是 Base64 图片格式返回 true，否则返回 false
      */
-    getUrlParam(url: string, key: string): string | number | boolean | any;
+    isBase64Img(str: any): boolean;
     /**
-     * 获取 URL 路径中的所有参数
-     * @param url
+     * 判断字符串是否全部是中文
+     * @param chs 待检测的字符串
+     * @returns 如果全部是中文字符返回 true，否则返回 false
      */
-    getUrlParams(url: string): QueryParams;
+    isChinese(chs: any_str): boolean;
     /**
-     * 获取 URL 路径中的 search 值
-     * @param url
+     * 判断对象是否为函数类型
+     * @param obj 待检测的对象
+     * @returns 如果是函数类型返回 true，否则返回 false
      */
+    isFunction: (obj: any) => boolean;
     /**
-     * 给定uri 解析
-     * @param source
-     * @param strictMode 是否严格模式
+     * 判断是否为 URL（必须包含协议部分）
+     * @param str 待检测的字符串
+     * @returns 如果是有效 URL（如 http://baidu.com）返回 true，否则返回 false
      */
-    parseUri(source: string | "", strictMode?: boolean): URI;
+    isUrl(str: any_str): boolean;
     /**
-     * 解析url查询参数 并封装为 参数 对象
-     * @param search
-     * @param strictMode
+     * 判断是否为 HTTP 协议
+     * @param str URL 字符串
+     * @returns 如果是 HTTP 协议返回 true，否则返回 false
      */
-    parseQuery(search: string | "", strictMode?: boolean): QueryParams;
+    isHttp(str: any): boolean;
     /**
-     * 获取查询参数
-     * @param search 查询参数，如果为空则会 从url 读取
-     * @param allowFromLocation 允许从 location 上获取
+     * 判断是否为 HTTPS 协议
+     * @param str URL 字符串
+     * @returns 如果是 HTTPS 协议返回 true，否则返回 false
+     */
+    isHttps(str: any): boolean;
+    /**
+     * 判断是否为有效的身份证号码
+     * @param str 身份证号码
+     * @returns 如果是有效的身份证号码返回 true，否则返回 false
+     */
+    isIDCard(str: string): boolean;
+    /**
+     * 是否为 IPv6 地址
+     * @param s 待检测的字符串
+     * @returns 如果是 IPv6 地址返回 true，否则返回 false
+     */
+    isIPv6(s: any): boolean;
+    /**
+     * 是否为 IPv4 地址
+     * @param s 待检测的字符串
+     * @returns 如果是 IPv4 地址返回 true，否则返回 false
+     */
+    isIPv4(s: any): boolean;
+    /**
+     * 是否为 IP 地址（IPv4 或 IPv6）
+     * @param str 待检测的字符串
+     * @returns 如果是 IP 地址返回 true，否则返回 false
+     */
+    isIP(str: any): any;
+    /**
+     * 是否为闰年
+     * @param str 年份，yyyy 格式
+     * @returns 如果是闰年返回 true，否则返回 false
+     */
+    isLeapYear(str: number | string): boolean;
+    /**
+     * 是否为手机号码
+     * @param str 待检测的字符串
+     * @param country 国家编号，默认为 'cn'（中国），可选 'us'（美国）等
+     * @returns 如果是手机号码返回 true，否则返回 false
+     */
+    isMobile(str: any_str, country?: string | "cn"): boolean;
+    /**
+     * 是否为邮箱地址
+     * @param email 待检测的邮箱字符串
+     * @returns 如果是邮箱地址返回 true，否则返回 false
+     */
+    isEmail(email: string): boolean;
+    /**
+     * 校验是否包含非法字符（脚本内容）
+     * @param text 待检测的文本
+     * @returns 如果包含非法字符返回 true，否则返回 false
+     */
+    isScript(text: string): boolean;
+    /**
+     * 是否为 String 类型
+     * @param obj 待检测的对象
+     * @returns 如果是 String 类型返回 true，否则返回 false
+     */
+    isString(obj: any): boolean;
+    /**
+     * 判断对象是否为 true
+     * <pre>
+     *   内置 true 枚举值：[true, 1, "1", "true", "TRUE", "Y", 'y', "YES", "yes", "ON", "on", '是', '开']
+     * </pre>
+     * @param obj 待检测的对象
+     * @returns 如果满足 true 枚举值返回 true，否则返回 false
+     */
+    isTrue(obj: any): boolean;
+    /**
+     * 判断对象是否为 boolean 类型或布尔值字符串
+     * <pre>
+     *   内置 true 枚举值：[true, 1, "1", "true", "TRUE", "Y", 'y', "YES", "yes", "ON", "on", '是', '开']
+     *   内置 false 枚举值：[false, 0, "0", "false", "FALSE", "N", 'n', "NO", "no", "OFF", "off", '否', '关']
+     * </pre>
+     * 与 isTrue 的区别：
+     * <pre>
+     *   1、isTrue：满足内置 true 枚举值返回 true，否则返回 false
+     *   2、isBoolean：满足内置 true 或 false 枚举值中任意值返回 true，否则返回 false
+     * </pre>
+     * @param obj 待检测的对象
+     * @returns 如果是布尔类型或布尔值字符串返回 true，否则返回 false
+     */
+    isBoolean(obj: any): boolean;
+    /**
+     * 判断字符串是否为整数
+     * @param value 待检测的字符串
+     * @returns 如果是整数返回 true，否则返回 false
+     */
+    isInteger(value: any_str): boolean;
+    /**
+     * 判断字符串是否为数字格式
+     * @param str 待检测的字符串
+     * @returns 如果是数字格式返回 true，否则返回 false
+     */
+    isNumber(str: any): boolean;
+    /**
+     * 解析 URL 查询参数并封装为参数对象
+     * @param search URL 查询参数字符串
+     * @returns 查询参数对象
+     */
+    parseQuery(search: string | ""): QueryParams;
+    /**
+     * 解析 URI
+     * @param source URI 字符串
+     * @param strictMode 是否使用严格模式解析
+     * @returns 解析后的 URI 对象
      */
-    getQueryParams(search?: string, allowFromLocation?: boolean): QueryParams;
+    parseUri(source: string | "", strictMode?: boolean): URI;
     /**
-     * 新增参数到URL上
-     * @param url url
+     * 新增参数到 URL 上
+     * @param url URL 字符串
      * @param key 参数名
      * @param value 参数值
-     * @param override 是否覆盖原有参数，默认=false
-     * @return new url
+     * @param override 是否覆盖原有参数，默认为 false
+     * @returns 新的 URL 字符串
      */
     addParamToURL(url: string, key: string, value: any, override?: boolean): string;
     /**
-     * 新增参数到URL上
-     * @param url url
+     * 新增参数对象到 URL 上
+     * @param url URL 字符串
      * @param params 参数对象
-     * @param override 是否覆盖原有参数，默认=false
-     * @return new url
+     * @param override 是否覆盖原有参数，默认为 false
+     * @returns 新的 URL 字符串
      */
     addParamObjToURL(url: string, params: Record<any, any> | object, override?: boolean): string;
     /**
-     * 删除参数到URL上
-     * @param url url
-     * @param keys 参数
-     * @return new url
-     **/
-    removeParamFromURL(url: string, keys?: string[] | string): string;
-    /**
-     * 字符串是否全部是中文
-     * @param obj
+     * 从 URL 上删除参数
+     * @param url URL 字符串
+     * @param keys 要删除的参数名（字符串或数组）
+     * @returns 新的 URL 字符串
      */
-    isChinese(obj: any_str): boolean;
+    removeParamFromURL(url: string, keys?: string[] | string): string;
     /**
-     * 是否为数组类型
-     * @param obj
+     * 随机打乱数组顺序
+     * @param arr 待打乱的数组
+     * @returns 打乱后的数组
      */
-    isArray(obj: any): boolean;
+    shuffle: typeof shuffle;
     /**
-     * 判断是否为空 支持对象 字符串，map set array 等
-     * @param str
+     * 左填充内容
+     * @param str 基础字符串
+     * @param len 填充后的总长度
+     * @param ch 填充字符，默认为空格
+     * @returns 填充后的字符串
      */
-    isEmpty(str: any): boolean;
+    lpad(str: any_str, len: number, ch?: string): any_str;
     /**
-     * 判断是否为空
-     * @param str
+     * 右填充内容
+     * @param str 基础字符串
+     * @param len 填充后的总长度
+     * @param ch 填充字符，默认为空格
+     * @returns 填充后的字符串
      */
-    isBlank(str: any): boolean;
+    rpad(str: any_str, len: number, ch?: string): any_str;
     /**
-     * 是否为手机号
-     * @param str
-     * @param contry 国家编号， 默认 cn,表示中国， us=美国
+     * 下划线转驼峰
+     * @param str 下划线格式的字符串
+     * @returns 驼峰格式的字符串
      */
-    isMobile(str: any_str, contry?: string | 'cn'): boolean;
+    toCamelCase(str: any): any;
     /**
-     * 判断是否是安卓设备
+     * 驼峰转下划线
+     * @param str 驼峰格式的字符串
+     * @param lowerCase 是否转为小写，默认为 true
+     * @returns 下划线格式的字符串
      */
-    isAndroid(): boolean;
+    toUnderlineCase(str: any, lowerCase?: boolean): any;
     /**
-     * 是否为闰年
-     * @param str yyyy格式
+     * 去除字符串空白
+     * @param str 基础字符串
+     * @param flag 去除模式：0=去除左右空白，1=去除左边空白，2=去除右边空白，默认为 0
+     * @returns 去除空白后的字符串
      */
-    isLeapYear(str: number | string): boolean;
+    trim<T = string>(str: T, flag?: TrimMode): any;
     /**
-     * 校验非法字符
-     * @param str
+     * 去除字符串左边的内容
+     * @param str 基础字符串
+     * @param prefix 要去除的左边内容，如果不指定则去除左边空白
+     * @returns 去除后的字符串
      */
-    isScript(str: string): boolean;
+    trimLeft<T = string>(str: T, prefix?: string): T;
     /**
-     * 判断是否为 身份证
-     * @param obj
+     * 去除字符串右边的内容
+     * @param str 基础字符串
+     * @param suffix 要去除的右边内容，如果不指定则去除右边空白
+     * @returns 去除后的字符串
      */
-    isIDCard(obj: string): boolean;
+    trimRight<T = string>(str: T, suffix?: string): T;
     /**
-     * 从身份证获取年龄
-     * @param obj
-     */
-    getAgeFromIDcard(obj: string): [year, moth, day] | [];
-    /**
-     * 判断是否为URL 这里只判断 str 必须有协议部分，比如：http://baidu.com 则返回true, //baidu.com 或者 baidu.com 返回false
-     * @param str
+     * 获取对象类型
+     * <pre>
+     *   例如：
+     *   type('123') 返回 'String'
+     *   type(133) 返回 'Number'
+     *   type([]) 返回 'Array'
+     *   type() 返回 'Undefined'
+     *   type(null) 返回 'Null'
+     * </pre>
+     * @param obj 待检测的对象
+     * @returns 对象类型字符串
      */
-    isUrl(str: any_str): boolean;
+    type(obj: any): string;
     /**
-     * 判断 是否为http
-     * @param str
+     * 生成 32 位 UUID
+     * @returns UUID 字符串
      */
-    isHttp(str: any_str): boolean;
+    uuid(): string;
     /**
-     * 判断是否为 https
-     * @param str
+     * 生成随机字符串
      */
-    isHttps(str: any_str): boolean;
+    random: typeof random;
     /**
-     * 是否为IP V6
-     * @param str
+     * 数据分页
+     * <pre>
+     *   例如：
+     *   page([1,2,3,4,5,6,7,8,9,10], 3) 返回 [[1,2,3],[4,5,6],[7,8,9],[10]]
+     *   page([1,2,3,4,5,6,7,8,9,10], 3, 3) 返回 [[7,8,9]]
+     * </pre>
+     * @param arr 数据列表
+     * @param pageSize 分页大小
+     * @param pageNo 页码（从 1 开始），不指定则返回全部分页数据
+     * @returns 分页后的数组
      */
-    isIPv6(str: any_str): boolean;
-    isIPv4(str: any_str): boolean;
+    page(arr: any, pageSize: any, pageNo: any): any[];
     /**
-     * 获取当前IP
-     * @param str
-     * @param v6
+     * 获取当前浏览器 DPI
+     * @returns DPI 值
      */
-    isIP(str: any_str, v6?: boolean): boolean;
     getDPI(): number;
     /**
      * 毫米转像素
-     * @param mm
-     * @param dpi 默认使用当前电脑屏幕 dpi
+     * @param mm 毫米值
+     * @param dpi DPI 值，默认使用当前屏幕 DPI
+     * @returns 像素值
      */
     mm2px(mm: number, dpi?: number): number;
     /**
      * 像素转毫米
-     * @param px
-     * @param dpi 默认使用当前电脑 dpi
+     * @param px 像素值
+     * @param dpi DPI 值，默认使用当前屏幕 DPI
+     * @returns 毫米值
      */
     px2mm(px: number, dpi?: number): number;
     /**
-     * 英寸转转像素
-     * @param inc
-     * @param dpi
+     * 英寸转像素
+     * @param inc 英寸值
+     * @param dpi DPI 值，默认使用当前屏幕 DPI
+     * @returns 像素值
      */
     in2px(inc: number, dpi: number): number;
     /**
      * 像素转英寸
-     * @param px
-     * @param dpi
+     * @param px 像素值
+     * @param dpi DPI 值，默认使用当前屏幕 DPI
+     * @returns 英寸值
      */
     px2in(px: number, dpi: number): number;
     /**
      * 英寸转毫米
-     * @param inc
+     * @param inc 英寸值
+     * @returns 毫米值
      */
     in2mm(inc: number): number;
     /**
      * 毫米转英寸
-     * @param mm
+     * @param mm 毫米值
+     * @returns 英寸值
      */
     mm2in(mm: number): number;
     /**
-     * 获取 innerText
-     * @param str
+     * 获取 innerText（去除 HTML 标签）
+     * @param str HTML 字符串
+     * @returns 去除 HTML 标签后的纯文本
      */
     getInnerText(str: string): string;
+    /**
+     * 克隆对象（深拷贝）
+     * @param obj 待克隆的对象
+     * @param deep 是否深拷贝，默认 true
+     * @returns 克隆后的对象
+     * @example
+     * // 深拷贝对象
+     * const cloned = Utils.clone({ a: 1, b: { c: 2 } });
+     *
+     * // 浅拷贝
+     * const shallow = Utils.clone({ a: 1, b: { c: 2 } }, false);
+     *
+     * // 克隆数组
+     * const arr = Utils.clone([1, 2, { x: 3 }]);
+     *
+     * // 克隆 Date
+     * const date = Utils.clone(new Date());
+     *
+     * // 克隆 Map/Set
+     * const map = Utils.clone(new Map([['a', 1]]));
+     * const set = Utils.clone(new Set([1, 2, 3]));
+     */
+    clone<T>(obj: T, deep?: boolean): T;
 };
-/**
- * 随机生成UUID
- * @param len 长度
- */
-export declare function uuid(len: number): string;
-export declare function isArrayLike(obj: any): boolean;
-export declare function isArray(obj: any): boolean;
-export declare function shuffle<T>(arr: any): any;
-/**
- * 获取随机数, 默认 字母+数组
- * @param len 随机数长度
- * @param typeOrSource 随机数类型：1=字母+数字， 2=数字 ， 3=字母,或者自定义数据源
- */
-export declare function random(len?: number, typeOrSource?: RandomTypeOrSource): string;
-declare const _Utils_: Utils;
 export default _Utils_;
+export declare type Utils = typeof _Utils_;