@jhqn/utils-core 0.0.3-beta.7 → 0.0.3

package/dist/index.d.cts

@@ -7,6 +7,90 @@ import { ConfigType } from 'dayjs';
 export { Dayjs, default as dayjs } from 'dayjs';
 export { detect } from 'detect-browser';
 
+/**
+ * 数字或字符串
+ */
+type Numeric = number | string;
+/**
+ * 可 Null
+ */
+type Nullable<T> = T | null;
+/**
+ * 可 Undefined
+ */
+type Undefinable<T> = T | undefined;
+/**
+ * 可 Null 或 Undefined
+ */
+type NullOrUndefinable<T> = Nullable<Undefinable<T>>;
+/**
+ * alias for NullOrUndefinable
+ */
+type UnDef<T> = NullOrUndefinable<T>;
+/**
+ * 请求结果
+ */
+type Res<T = any> = Service.Response<T>;
+/**
+ * 分页请求结果数据
+ */
+type PageResData<T = any> = Service.PageResponseData<T>;
+/**
+ * 分页请求结果
+ */
+type PageRes<T = any> = Service.PageResponse<T>;
+/**
+ * 分页请求参数
+ */
+type PageReq<T extends Record<string, any> = NonNullable<unknown>> = Service.PageRequestParams<T>;
+/**
+ * 可能是数组
+ */
+type MaybeArray<T = any> = T | Array<T>;
+/**
+ * 枚举键值对
+ */
+type VK<T = string> = Record<string | number, T>;
+/**
+ * 字典
+ */
+type Dict<T = string> = Record<string, T>;
+/**
+ * 使某键可选
+ */
+type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
+
+interface HostEnv {
+  /**
+   * 是否是浙里办
+   */
+  readonly zlb: boolean
+  /**
+   * 是否是专有钉
+   */
+  readonly zyd: boolean
+  /**
+   * 是否是浙政钉
+   */
+  readonly zzd: boolean
+  /**
+   * 是否是钉钉/专有钉/浙政钉
+   */
+  readonly dd: boolean
+  /**
+   * 是否是微信
+   */
+  readonly wx: boolean
+  /**
+   * 是否是支付宝
+   */
+  readonly zfb: boolean
+  /**
+   * 是否是小程序
+   */
+  readonly mini: boolean
+}
+
 /**
  * snake2Kebab
  * @param {string} str 字符串
@@ -217,150 +301,129 @@ declare const jLogDedupe: (...args: any[]) => void;
  */
 declare const jLogOnce: (...args: any[]) => void;
 
-/**
- * 数字或字符串
- */
-type Numeric = number | string;
-/**
- * 可 Null
- */
-type Nullable<T> = T | null;
-/**
- * 可 Undefined
- */
-type Undefinable<T> = T | undefined;
-/**
- * 可 Null 或 Undefined
- */
-type NullOrUndefinable<T> = Nullable<Undefinable<T>>;
-/**
- * alias for NullOrUndefinable
- */
-type UnDef<T> = NullOrUndefinable<T>;
-/**
- * 请求结果
- */
-type Res<T = any> = Service.Response<T>;
-/**
- * 分页请求结果数据
- */
-type PageResData<T = any> = Service.PageResponseData<T>;
-/**
- * 分页请求结果
- */
-type PageRes<T = any> = Service.PageResponse<T>;
-/**
- * 分页请求参数
- */
-type PageReq<T extends Record<string, any> = NonNullable<unknown>> = Service.PageRequestParams<T>;
-/**
- * 可能是数组
- */
-type MaybeArray<T = any> = T | Array<T>;
-/**
- * 枚举键值对
- */
-type VK<T = string> = Record<string | number, T>;
-/**
- * 字典
- */
-type Dict<T = string> = Record<string, T>;
-/**
- * 使某键可选
- */
-type PartialBy<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
-
 /**
  * 隐藏中间部分
  * @param {string} str 需要隐藏的字符串
+ * @returns {string} 隐藏后的字符串
+ * @example
+ * ```ts
+ * hideMiddle('A') // '*'
+ * hideMiddle('AB') // '**'
+ * hideMiddle('ABC') // 'A*C'
+ * hideMiddle('ABCD') // 'A**D'
+ * hideMiddle('ABCDE') // 'A***E'
+ * ```
  */
 declare const hideMiddle: (str: UnDef<string>) => string;
 /**
  * 隐藏首尾仅保留中间3分之1
  * @param {string} str 需要隐藏的字符串
+ * @returns {string} 隐藏后的字符串
+ * @example
+ * ```ts
+ * hideThird('A') // '*'
+ * hideThird('AB') // '**'
+ * hideThird('ABC') // 'A*C'
+ * hideThird('ABCD') // 'A**D'
+ * hideThird('ABCDE') // 'AB*DE'
+ * ```
  */
 declare const hideThird: (str: UnDef<string>) => string;
 /**
  * 隐藏首部
  * @param {string} str 需要隐藏的字符串
  * @param {number} count 隐藏的字符数
+ * @returns {string} 隐藏后的字符串
+ * @example
+ * ```ts
+ * hideHead('A') // '*'
+ * hideHead('AB') // '*B'
+ * hideHead('ABC') // '**C'
+ * hideHead('ABC', 1) // '*BC'
+ * ```
  */
 declare const hideHead: (str: UnDef<string>, count?: number) => string;
 /**
  * 隐藏尾部
  * @param {string} str 需要隐藏的字符串
  * @param {number} count 隐藏的字符数
+ * @returns {string} 隐藏后的字符串
+ * @example
+ * ```ts
+ * hideTail('A') // '*'
+ * hideTail('AB') // 'A*'
+ * hideTail('ABC') // 'A**'
+ * hideTail('ABC', 1) // 'AB*'
+ * ```
  */
 declare const hideTail: (str: UnDef<string>, count?: number) => string;
 /**
- * 隐藏手机号
- * @param {string} phone 手机号
+ * 隐藏手机号/座机号
+ * @param {string} phone 手机号/座机号
+ * @returns {string} 隐藏后的手机号/座机号
+ * @example
+ * ```ts
+ * hidePhone('13800138000') // '138****8000'
+ * hidePhone('010-12345678') // '010****5678'
+ * hidePhone('(010)12345678') // '(010)****5678'
+ * ```
  */
 declare const hidePhone: (phone: UnDef<string>) => string;
 /**
  * 隐藏身份证号
  * @param {string} cardNo 身份证号
  * @param {boolean} strong 是否强化隐藏
+ * @returns {string} 隐藏后的身份证号
+ * @example
+ * ```ts
+ * hideCardNo('33072319641008384x') // '3****************x'
+ * hideCardNo('33072319641008384x', false) // '3***23196410*****x'
+ * ```
  */
 declare const hideCardNo: (cardNo: UnDef<string>, strong?: boolean) => string;
-/**
- * 隐藏姓名第一个字
- * @param {string} name 姓名
- * @deprecated 请使用 hideSurname
- */
-declare const hideName: (name: UnDef<string>) => string;
 /**
  * 隐藏姓氏
  * @param {string} name 姓名
+ * @returns {string} 隐藏后的姓名
+ * @example
+ * ```ts
+ * hideSurname('张三') // '*三'
+ * hideSurname('司马懿') // '*马懿'
+ * ```
  */
 declare const hideSurname: (name: UnDef<string>) => string;
 /**
  * 隐藏名字
  * @param {string} name 姓名
+ * @returns {string} 隐藏后的姓名
+ * @example
+ * ```ts
+ * hideFirstName('张三') // '张*'
+ * hideFirstName('司马懿') // '司马*'
+ * ```
  */
 declare const hideFirstName: (name: UnDef<string>) => string;
 /**
  * 隐藏邮箱
  * @param {string} email 邮箱
+ * @returns {string} 隐藏后的邮箱
+ * @example
+ * ```ts
+ * hideEmail('example@hotmail.com') // 'exam***@hotmail.com'
+ * ```
  */
 declare const hideEmail: (email: UnDef<string>) => string;
 /**
  * 隐藏银行卡号
  * @param {string} bankCard 银行卡号
+ * @returns {string} 隐藏后的银行卡号
+ * @example
+ * ```ts
+ * hideBankCard('6222021001123456789') // '622202********6789'
+ * ```
  */
 declare const hideBankCard: (bankCard: UnDef<string>) => string;
 
-interface HostEnv {
-  /**
-   * 是否是浙里办
-   */
-  readonly zlb: boolean
-  /**
-   * 是否是专有钉
-   */
-  readonly zyd: boolean
-  /**
-   * 是否是浙政钉
-   */
-  readonly zzd: boolean
-  /**
-   * 是否是钉钉/专有钉/浙政钉
-   */
-  readonly dd: boolean
-  /**
-   * 是否是微信
-   */
-  readonly wx: boolean
-  /**
-   * 是否是支付宝
-   */
-  readonly zfb: boolean
-  /**
-   * 是否是小程序
-   */
-  readonly mini: boolean
-}
-
 /**
  * 判断是否是浏览器环境
  */
@@ -409,23 +472,52 @@ declare const getCodeOfDate: () => number;
 declare const getCodeOfMonth: () => number;
 
 /**
- * Json字符串转对象
- * @param str
- * @param reviver
+ * 设置文件基本路径
+ * @param baseUrl
+ */
+declare function setBaseAttachUrl(baseUrl: string): void;
+/**
+ * 获取文件基本路径
  */
-declare const parseToJSON: <T = any>(str: string, reviver?: (this: any, key: string, value: any) => any) => Nullable<T>;
+declare function getBaseAttachUrl(): string;
+
+/**
+ * JSON 字符串转对象
+ * @template T - 解析数据类型
+ * @param {string} str - JSON字符串
+ * @param {(this: any, key: string, value: any) => any} reviverFn - 解析函数
+ * @returns {Nullable<T>} 解析后的对象
+ * @deprecated 请使用 `parseJSON`
+ */
+declare function parseToJSON<T = any>(str: string, reviverFn?: (this: any, key: string, value: any) => any): Nullable<T>;
+/**
+ * JSON 字符串转对象
+ * @alias parseToJSON
+ * @template T - 解析数据类型
+ * @param {string} str - JSON字符串
+ * @param {(this: any, key: string, value: any) => any} reviverFn - 解析函数
+ * @returns {Nullable<T>} 解析后的对象
+ */
+declare function parseJSON<T = any>(str: string, reviverFn?: (this: any, key: string, value: any) => any): Nullable<T>;
+/**
+ * 对象转 JSON 字符串
+ * @param {any} value - 对象
+ * @param {(this: any, key: string, value: any) => any} replacerFn - 替换函数
+ * @returns {string} JSON 字符串
+ */
+declare function stringifyJSON(value: any, replacerFn?: (this: any, key: string, value: any) => any): string;
 /**
  * JSON.stringify() second param
- * @param _
+ * @param _key
  * @param value
  */
-declare const replacer: (_: any, value: any) => any;
+declare function replacer(_key: any, value: any): any;
 /**
  * JSON.parse() second param
- * @param _
+ * @param _key
  * @param value
  */
-declare const reviver: (_: any, value: any) => any;
+declare function reviver(_key: any, value: any): any;
 /**
  * 过滤obj中仅包括keys的部分
  * @param {Record<string,any>} obj 对象
@@ -436,13 +528,25 @@ declare const filterObj: (obj: Record<string, any>, keys: string[], reverse?: bo
     [k: string]: any;
 };
 
+/**
+ * 千位分隔符
+ * @param num
+ */
+declare const toThousands: (num: number) => string | undefined;
+/**
+ * 货币格式化
+ * @param {number | string | bigint} currency - 金额
+ * @param {number} [maximumFractionDigits] - 小数位数
+ */
+declare const currencyFmt: (currency: UnDef<Numeric | bigint>, maximumFractionDigits?: number) => string;
+
 /**
  * 格式化时间
  * @param {import('dayjs').ConfigType} date 时间
  * @param {string} format 格式
  * @returns {string} 格式化后的时间
  */
-declare const dateFmt: (date: ConfigType, format?: string | 'date' | 'datetime') => string;
+declare const dateFmt: (date: ConfigType, format?: string | "date" | "datetime") => string;
 /**
  * 格式化时间间隔
  * @param {import('dayjs').ConfigType} start 开始时间
@@ -450,28 +554,6 @@ declare const dateFmt: (date: ConfigType, format?: string | 'date' | 'datetime')
  */
 declare const dateDuration: (start: ConfigType, end: ConfigType) => string;
 
-/**
- * 设置文件基本路径
- * @param baseUrl
- */
-declare function setBaseAttachUrl(baseUrl: string): void;
-/**
- * 获取文件基本路径
- */
-declare function getBaseAttachUrl(): string;
-
-/**
- * 千位分隔符
- * @param num
- */
-declare const toThousands: (num: number) => string | undefined;
-/**
- * 货币格式化
- * @param {number | string | bigint} currency - 金额
- * @param {number} [maximumFractionDigits] - 小数位数
- */
-declare const currencyFmt: (currency: UnDef<Numeric | bigint>, maximumFractionDigits?: number) => string;
-
 type VantUploadFileStatus = '' | 'uploading' | 'done' | 'failed'
 type AntdUploadFileStatus = 'removed' | 'uploading' | 'done' | 'error'
 type ElementPlusUploadFileStatus = 'ready' | 'uploading' | 'success' | 'fail'
@@ -520,16 +602,16 @@ declare const recoverFile: (resource: Resource) => {
     group: string;
     id: string;
     name: string;
-    size?: number | undefined;
-    uid?: string | undefined;
-    objectUrl?: string | undefined;
-    isImage?: boolean | undefined;
-    message?: string | undefined;
-    deletable?: boolean | undefined;
-    reupload?: boolean | undefined;
-    fileName?: string | undefined;
-    thumbUrl?: string | undefined;
-    percentage?: number | undefined;
+    size?: number;
+    uid?: string;
+    objectUrl?: string;
+    isImage?: boolean;
+    message?: string;
+    deletable?: boolean;
+    reupload?: boolean;
+    fileName?: string;
+    thumbUrl?: string;
+    percentage?: number;
 };
 /**
  * 附件格式
@@ -544,16 +626,16 @@ declare const attachFmt: (data: UnDef<MaybeArray<Resource>> | string) => {
     group: string;
     id: string;
     name: string;
-    size?: number | undefined;
-    uid?: string | undefined;
-    objectUrl?: string | undefined;
-    isImage?: boolean | undefined;
-    message?: string | undefined;
-    deletable?: boolean | undefined;
-    reupload?: boolean | undefined;
-    fileName?: string | undefined;
-    thumbUrl?: string | undefined;
-    percentage?: number | undefined;
+    size?: number;
+    uid?: string;
+    objectUrl?: string;
+    isImage?: boolean;
+    message?: string;
+    deletable?: boolean;
+    reupload?: boolean;
+    fileName?: string;
+    thumbUrl?: string;
+    percentage?: number;
 }[];
 
 /**
@@ -619,7 +701,7 @@ declare const isObject: (val: any) => val is Record<any, any>;
  * 是否是数组
  * @param {any} val 检测的目标
  */
-declare const isArray: (val: any) => val is any[];
+declare const isArray: (val: any) => val is Array<any>;
 /**
  * 是否是函数，但也有可能是Class
  * @param {any} val 检测的目标
@@ -707,38 +789,30 @@ declare const isArrStr: (str: UnDef<string>) => boolean;
  * ```
  * @returns {boolean} boolean
  */
-declare const isValidKey: (key: string | number | symbol, object: object) => key is never;
+declare const isValidKey: (key: string | number | symbol, object: object) => key is keyof typeof object;
 /**
  * 是否是空值/空数组/空对象 null undefined '' [] {} Set Map
  * @param val
  */
 declare const isEmpty: (val: UnDef<Numeric | boolean | Record<any, any> | Array<any> | Set<any> | Map<any, any>>) => boolean;
 
-/**
- * 校验接口返回code
- * @param res
- * @param code
- */
-declare const isValidResCode: (res: Res, code?: number) => boolean;
-/**
- * 校验接口返回内容
- * @param res
- * @param code
- */
-declare const isValidRes: (res: Res, code?: number) => boolean;
-/**
- * 校验接口数组返回内容
- * @param res
- * @param code
+declare const cnPhoneRE: RegExp;
+declare const cnTelRE: RegExp;
+declare const cnTelRE2: RegExp;
+declare const cnUSCIRE: RegExp;
+declare const cnIdCard15Re: RegExp;
+declare const cnIdCard18Re: RegExp;
+declare const emailRE: RegExp;
+/**
+ * 是否是[统一社会信用代码](https://zh.wikipedia.org/zh-cn/%E7%BB%9F%E4%B8%80%E7%A4%BE%E4%BC%9A%E4%BF%A1%E7%94%A8%E4%BB%A3%E7%A0%81)
+ * @example
+ * ```ts
+ * isUSCI('91350100M000100Y43') // true
+ * ```
+ * @param {UnDef<string>} val - 待校验的值
+ * @returns {boolean} 是否是统一社会信用代码
  */
-declare const isValidArrRes: (res: Res<any[]>, code?: number) => boolean;
-/**
- * 校验接口分页返回内容
- * @param res
- * @param code
- */
-declare const isValidPageRes: (res: PageRes, code?: number) => boolean;
-
+declare const isUSCI: (val: UnDef<string>) => boolean;
 /**
  * 是否是中国手机号
  * @param val
@@ -783,4 +857,30 @@ declare const nonASCII: (text: string) => boolean;
  */
 declare const isValidFileType: (file: File, type: string) => boolean;
 
-export { type Dict, type MaybeArray, type NullOrUndefinable, type Nullable, type Numeric, type PageReq, type PageRes, type PageResData, type PartialBy, type Res, type UnDef, type Undefinable, type VK, attachFmt, camel2Kebab, camel2Pascal, camel2Snake, camel2Title, checkImg, currencyFmt, dateDuration, dateFmt, filterObj, fixiOSInputAutoZoomIn, getBaseAttachUrl, getCodeOfDate, getCodeOfHour, getCodeOfMonth, getHostEnv, getVariableType, hideBankCard, hideCardNo, hideEmail, hideFirstName, hideHead, hideMiddle, hideName, hidePhone, hideSurname, hideTail, hideThird, inBrowser, isArrStr, isArray, isBigInt, isBlob, isBoolean, isDate, isDef, isEmail, isEmpty, isError, isFile, isFunction, isIdCard, isJSONStr, isMap, isNull, isNumber, isNumeric, isObject, isPhone, isPromise, isRegExp, isSet, isString, isSymbol, isTel, isURL, isUndefined, isValidArrRes, isValidFileType, isValidKey, isValidPageRes, isValidRes, isValidResCode, isWeakMap, isWeakSet, jClear, jDebug, jError, jGroup, jGroupC, jGroupE, jInfo, jLog, jLogDedupe, jLogOnce, jTime, jTimeEnd, jWarn, kebab2Camel, kebab2Pascal, kebab2Snake, kebab2Title, naturalSort, naturalSortBy, nonASCII, parseToJSON, pascal2Camel, pascal2Kebab, pascal2Snake, pascal2Title, recoverFile, replacer, resUrl, reviver, setBaseAttachUrl, snake2Camel, snake2Kebab, snake2Pascal, snake2Title, title2Camel, title2Kebab, title2Pascal, title2Snake, toThousands, userAgent, waitTime };
+/**
+ * 校验接口返回code
+ * @param res
+ * @param code
+ */
+declare const isValidResCode: (res: Res, code?: number) => boolean;
+/**
+ * 校验接口返回内容
+ * @param res
+ * @param code
+ */
+declare const isValidRes: (res: Res, code?: number) => boolean;
+/**
+ * 校验接口数组返回内容
+ * @param res
+ * @param code
+ */
+declare const isValidArrRes: (res: Res<any[]>, code?: number) => boolean;
+/**
+ * 校验接口分页返回内容
+ * @param res
+ * @param code
+ */
+declare const isValidPageRes: (res: PageRes, code?: number) => boolean;
+
+export { attachFmt, camel2Kebab, camel2Pascal, camel2Snake, camel2Title, checkImg, cnIdCard15Re, cnIdCard18Re, cnPhoneRE, cnTelRE, cnTelRE2, cnUSCIRE, currencyFmt, dateDuration, dateFmt, emailRE, filterObj, fixiOSInputAutoZoomIn, getBaseAttachUrl, getCodeOfDate, getCodeOfHour, getCodeOfMonth, getHostEnv, getVariableType, hideBankCard, hideCardNo, hideEmail, hideFirstName, hideHead, hideMiddle, hidePhone, hideSurname, hideTail, hideThird, inBrowser, isArrStr, isArray, isBigInt, isBlob, isBoolean, isDate, isDef, isEmail, isEmpty, isError, isFile, isFunction, isIdCard, isJSONStr, isMap, isNull, isNumber, isNumeric, isObject, isPhone, isPromise, isRegExp, isSet, isString, isSymbol, isTel, isURL, isUSCI, isUndefined, isValidArrRes, isValidFileType, isValidKey, isValidPageRes, isValidRes, isValidResCode, isWeakMap, isWeakSet, jClear, jDebug, jError, jGroup, jGroupC, jGroupE, jInfo, jLog, jLogDedupe, jLogOnce, jTime, jTimeEnd, jWarn, kebab2Camel, kebab2Pascal, kebab2Snake, kebab2Title, naturalSort, naturalSortBy, nonASCII, parseJSON, parseToJSON, pascal2Camel, pascal2Kebab, pascal2Snake, pascal2Title, recoverFile, replacer, resUrl, reviver, setBaseAttachUrl, snake2Camel, snake2Kebab, snake2Pascal, snake2Title, stringifyJSON, title2Camel, title2Kebab, title2Pascal, title2Snake, toThousands, userAgent, waitTime };
+export type { Dict, HostEnv, MaybeArray, NullOrUndefinable, Nullable, Numeric, PageReq, PageRes, PageResData, PartialBy, Res, UnDef, Undefinable, VK };