@jhqn/utils-core 0.0.1-beta.22 → 0.0.1-beta.24

package/dist/index.d.cts

@@ -0,0 +1,738 @@
+/// <reference types="dayjs/plugin/localeData" />
+/// <reference types="dayjs/plugin/duration" />
+/// <reference types="dayjs/plugin/relativeTime" />
+/// <reference types="dayjs/plugin/customParseFormat" />
+/// <reference types="dayjs/plugin/objectSupport" />
+import * as detect_browser from 'detect-browser';
+import { ConfigType } from 'dayjs';
+export { Dayjs, default as dayjs } from 'dayjs';
+
+/**
+ * snake2Kebab
+ * @param {string} str 字符串
+ * @returns {string} 转换后的字符串
+ * @example snake2Kebab('hello_world') // hello_world => hello-world
+ */
+declare const snake2Kebab: (str: string) => string;
+/**
+ * snake2Pascal
+ * @param {string} str 字符串
+ * @returns {string} 转换后的字符串
+ * @example snake2Pascal('hello_world') // hello_world => HelloWorld
+ */
+declare const snake2Pascal: (str: string) => string;
+/**
+ * snake2Camel
+ * @param {string} str 字符串
+ * @returns {string} 转换后的字符串
+ * @example snake2Camel('hello_world') // hello_world => helloWorld
+ */
+declare const snake2Camel: (str: string) => string;
+/**
+ * snake2Title
+ * @param {string} str 字符串
+ * @returns {string} 转换后的字符串
+ * @example snake2Title('hello_world') // hello_world => Hello World
+ */
+declare const snake2Title: (str: string) => string;
+/**
+ * kebab2Snake
+ * @param {string} str 字符串
+ * @returns {string} 转换后的字符串
+ * @example kebab2Snake('hello-world') // hello-world => hello_world
+ */
+declare const kebab2Snake: (str: string) => string;
+/**
+ * kebab2Pascal
+ * @param {string} str 字符串
+ * @returns {string} 转换后的字符串
+ * @example kebab2Pascal('hello-world') // hello-world => HelloWorld
+ */
+declare const kebab2Pascal: (str: string) => string;
+/**
+ * kebab2Camel
+ * @param {string} str 字符串
+ * @returns {string} 转换后的字符串
+ * @example kebab2Camel('hello-world') // hello-world => helloWorld
+ */
+declare const kebab2Camel: (str: string) => string;
+/**
+ * kebab2Title
+ * @param {string} str 字符串
+ * @returns {string} 转换后的字符串
+ * @example kebab2Title('hello-world') // hello-world => Hello World
+ */
+declare const kebab2Title: (str: string) => string;
+/**
+ * pascal2Snake
+ * @param {string} str 字符串
+ * @returns {string} 转换后的字符串
+ * @example pascal2Snake('HelloWorld') // HelloWorld => hello_world
+ */
+declare const pascal2Snake: (str: string) => string;
+/**
+ * pascal2Kebab
+ * @param {string} str 字符串
+ * @returns {string} 转换后的字符串
+ * @example pascal2Kebab('HelloWorld') // HelloWorld => hello-world
+ */
+declare const pascal2Kebab: (str: string) => string;
+/**
+ * pascal2Camel
+ * @param {string} str 字符串
+ * @returns {string} 转换后的字符串
+ * @example pascal2Camel('HelloWorld') // HelloWorld => helloWorld
+ */
+declare const pascal2Camel: (str: string) => string;
+/**
+ * pascal2Title
+ * @param {string} str 字符串
+ * @returns {string} 转换后的字符串
+ * @example pascal2Title('HelloWorld') // HelloWorld => Hello World
+ */
+declare const pascal2Title: (str: string) => string;
+/**
+ * camel2Snake
+ * @param {string} str 字符串
+ * @returns {string} 转换后的字符串
+ * @example camel2Snake('helloWorld') // helloWorld => hello_world
+ */
+declare const camel2Snake: (str: string) => string;
+/**
+ * camel2Kebab
+ * @param {string} str 字符串
+ * @returns {string} 转换后的字符串
+ * @example camel2Kebab('helloWorld') // helloWorld => hello-world
+ */
+declare const camel2Kebab: (str: string) => string;
+/**
+ * camel2Pascal
+ * @param {string} str 字符串
+ * @returns {string} 转换后的字符串
+ * @example camel2Pascal('helloWorld') // helloWorld => HelloWorld
+ */
+declare const camel2Pascal: (str: string) => string;
+/**
+ * camel2Title
+ * @param {string} str 字符串
+ * @returns {string} 转换后的字符串
+ * @example camel2Title('helloWorld') // helloWorld => Hello World
+ */
+declare const camel2Title: (str: string) => string;
+/**
+ * title2Snake
+ * @param {string} str 字符串
+ * @returns {string} 转换后的字符串
+ * @example title2Snake('Hello World') // Hello World => hello_world
+ */
+declare const title2Snake: (str: string) => string;
+/**
+ * title2Kebab
+ * @param {string} str 字符串
+ * @returns {string} 转换后的字符串
+ * @example title2Kebab('Hello World') // Hello World => hello-world
+ */
+declare const title2Kebab: (str: string) => string;
+/**
+ * title2Pascal
+ * @param {string} str 字符串
+ * @returns {string} 转换后的字符串
+ * @example title2Pascal('Hello World') // Hello World => HelloWorld
+ */
+declare const title2Pascal: (str: string) => string;
+/**
+ * title2Camel
+ * @param {string} str 字符串
+ * @returns {string} 转换后的字符串
+ * @example title2Camel('Hello World') // Hello World => helloWorld
+ */
+declare const title2Camel: (str: string) => string;
+
+/**
+ * jade console.log
+ * only for development
+ * @param {...any} args
+ */
+declare const jLog: (...args: any[]) => void | (() => void);
+/**
+ * jade console.debug
+ * @param {...any} args
+ */
+declare const jDebug: (...args: any[]) => void;
+/**
+ * jade console.warn
+ */
+declare const jWarn: (...args: any[]) => void;
+/**
+ * jade console.error
+ */
+declare const jError: (...args: any[]) => void;
+/**
+ * jade console.info
+ * @param {...any} args
+ */
+declare const jInfo: (...args: any[]) => void;
+/**
+ * jade console.group
+ */
+declare const jGroup: (...args: any[]) => void;
+/**
+ * jade console.groupCollapsed
+ */
+declare const jGroupC: (...args: any[]) => void;
+/**
+ * jade console.groupEnd
+ */
+declare const jGroupE: {
+    (): void;
+    (): void;
+};
+/**
+ * jade console.time
+ * @param str
+ */
+declare const jTime: (str: string) => void;
+/**
+ * jade console.timeEnd
+ * @param str
+ */
+declare const jTimeEnd: (str: string) => void;
+/**
+ * jade console.clear
+ */
+declare const jClear: {
+    (): void;
+    (): void;
+};
+
+/**
+ * 数字或字符串
+ */
+declare type Numeric = number | string;
+/**
+ * 可 Null
+ */
+declare type Nullable<T> = T | null;
+/**
+ * 可 Undefined
+ */
+declare type Undefinable<T> = T | undefined;
+/**
+ * 可 Null 或 Undefined
+ */
+declare type NullOrUndefinable<T> = Nullable<Undefinable<T>>;
+/**
+ * 请求结果
+ */
+declare type Res<T = any> = Service.Response<T>;
+/**
+ * 分页请求结果数据
+ */
+declare type PageResData<T = any> = Service.PageResponseData<T>;
+/**
+ * 分页请求结果
+ */
+declare type PageRes<T = any> = Service.PageResponse<T>;
+/**
+ * 可能是数组
+ */
+declare type MaybeArray<T = any> = T | Array<T>;
+
+/**
+ * 隐藏中间部分
+ * @param {string} str 需要隐藏的字符串
+ */
+declare const hideMiddle: (str: NullOrUndefinable<string>) => string;
+/**
+ * 隐藏首尾仅保留中间3分之1
+ * @param {string} str 需要隐藏的字符串
+ */
+declare const hideThird: (str: NullOrUndefinable<string>) => string;
+/**
+ * 隐藏首部
+ * @param {string} str 需要隐藏的字符串
+ */
+declare const hideHead: (str: NullOrUndefinable<string>) => string;
+/**
+ * 隐藏尾部
+ * @param {string} str 需要隐藏的字符串
+ */
+declare const hideTail: (str: NullOrUndefinable<string>) => string;
+/**
+ * 隐藏手机号
+ * @param {string} phone 手机号
+ */
+declare const hidePhone: (phone: NullOrUndefinable<string>) => string;
+/**
+ * 隐藏身份证号
+ * @param {string} cardNo 身份证号
+ */
+declare const hideCardNo: (cardNo: NullOrUndefinable<string>) => string;
+/**
+ * 隐藏姓名第一个字
+ * @param {string} name 姓名
+ * @deprecated 请使用 hideSurname
+ */
+declare const hideName: (name: NullOrUndefinable<string>) => string;
+/**
+ * 隐藏姓氏
+ * @param {string} name 姓名
+ */
+declare const hideSurname: (name: NullOrUndefinable<string>) => string;
+/**
+ * 隐藏名字
+ * @param {string} name 姓名
+ */
+declare const hideFirstName: (name: NullOrUndefinable<string>) => string;
+/**
+ * 隐藏邮箱
+ * @param {string} email 邮箱
+ */
+declare const hideEmail: (email: NullOrUndefinable<string>) => string;
+
+/**
+ * 判断是否是浏览器环境
+ */
+declare const inBrowser: boolean;
+/**
+ * 等待一段时间
+ * @param time
+ */
+declare const waitTime: (time?: number) => Promise<unknown>;
+/**
+ * 防止 iOS 因输入框字体小于16px 而在 focus 时页面缩放变大需要手动回正的情况。
+ * iOS 10+ 允许 pinch-zoom， 即使 viewport 是不可伸缩的。
+ * 只对这些浏览器添加额外规则
+ */
+declare const fixiOSInputAutoZoomIn: () => void;
+/**
+ * 用户代理
+ */
+declare const userAgent: string;
+/**
+ * 获取宿主环境信息
+ */
+declare const getHostEnv: () => {
+    /**
+     * 是否是浙里办
+     */
+    zlb: boolean;
+    /**
+     * 是否是专有钉
+     */
+    zyd: boolean;
+    /**
+     * 是否是浙政钉
+     */
+    zzd: boolean;
+    /**
+     * 是否是微信
+     */
+    wx: boolean;
+    /**
+     * 是否是支付宝
+     */
+    zfb: boolean;
+    /**
+     * 是否是小程序
+     */
+    mini: boolean;
+} | {
+    /**
+     * 是否是浙里办
+     */
+    zlb: boolean;
+    /**
+     * 是否是专有钉
+     */
+    zyd: boolean;
+    /**
+     * 是否是浙政钉
+     */
+    zzd: boolean;
+    /**
+     * 是否是微信
+     */
+    wx: boolean;
+    /**
+     * 是否是支付宝
+     */
+    zfb: boolean;
+    /**
+     * 是否是小程序
+     */
+    mini: boolean;
+    name: detect_browser.Browser;
+    version: string;
+    os: detect_browser.OperatingSystem | null;
+    type: "browser";
+} | {
+    /**
+     * 是否是浙里办
+     */
+    zlb: boolean;
+    /**
+     * 是否是专有钉
+     */
+    zyd: boolean;
+    /**
+     * 是否是浙政钉
+     */
+    zzd: boolean;
+    /**
+     * 是否是微信
+     */
+    wx: boolean;
+    /**
+     * 是否是支付宝
+     */
+    zfb: boolean;
+    /**
+     * 是否是小程序
+     */
+    mini: boolean;
+    name: detect_browser.Browser;
+    version: string;
+    os: detect_browser.OperatingSystem | null;
+    bot: string;
+    type: "bot-device";
+} | {
+    /**
+     * 是否是浙里办
+     */
+    zlb: boolean;
+    /**
+     * 是否是专有钉
+     */
+    zyd: boolean;
+    /**
+     * 是否是浙政钉
+     */
+    zzd: boolean;
+    /**
+     * 是否是微信
+     */
+    wx: boolean;
+    /**
+     * 是否是支付宝
+     */
+    zfb: boolean;
+    /**
+     * 是否是小程序
+     */
+    mini: boolean;
+    type: "bot";
+    bot: true;
+    name: "bot";
+    version: null;
+    os: null;
+} | {
+    /**
+     * 是否是浙里办
+     */
+    zlb: boolean;
+    /**
+     * 是否是专有钉
+     */
+    zyd: boolean;
+    /**
+     * 是否是浙政钉
+     */
+    zzd: boolean;
+    /**
+     * 是否是微信
+     */
+    wx: boolean;
+    /**
+     * 是否是支付宝
+     */
+    zfb: boolean;
+    /**
+     * 是否是小程序
+     */
+    mini: boolean;
+    version: string;
+    type: "node";
+    name: "node";
+    os: NodeJS.Platform;
+} | {
+    /**
+     * 是否是浙里办
+     */
+    zlb: boolean;
+    /**
+     * 是否是专有钉
+     */
+    zyd: boolean;
+    /**
+     * 是否是浙政钉
+     */
+    zzd: boolean;
+    /**
+     * 是否是微信
+     */
+    wx: boolean;
+    /**
+     * 是否是支付宝
+     */
+    zfb: boolean;
+    /**
+     * 是否是小程序
+     */
+    mini: boolean;
+    type: "react-native";
+    name: "react-native";
+    version: null;
+    os: null;
+};
+
+/**
+ * Json字符串转对象
+ * @param str
+ * @param reviver
+ */
+declare const parseToJSON: <T = any>(str: string, reviver?: ((this: any, key: string, value: any) => any) | undefined) => Nullable<T>;
+/**
+ * JSON.stringify() second param
+ * @param _
+ * @param value
+ */
+declare const replacer: (_: any, value: any) => any;
+/**
+ * JSON.parse() second param
+ * @param _
+ * @param value
+ */
+declare const reviver: (_: any, value: any) => any;
+/**
+ * 过滤obj中仅包括keys的部分
+ * @param {Record<string,any>} obj 对象
+ * @param {string[]} keys 属性
+ * @param {boolean} reverse 为true时过滤取反
+ */
+declare const filterObj: (obj: Record<string, any>, keys: string[], reverse?: boolean) => {
+    [k: string]: any;
+};
+
+/**
+ * 格式化时间
+ * @param {import('dayjs').ConfigType} date 时间
+ * @param {string} format 格式
+ * @returns {string} 格式化后的时间
+ */
+declare const dateFmt: (date: ConfigType, format?: string | 'date' | 'datetime') => string;
+/**
+ * 格式化时间间隔
+ * @param {import('dayjs').ConfigType} start 开始时间
+ * @param {import('dayjs').ConfigType} end 结束时间
+ */
+declare const dateDuration: (start: ConfigType, end: ConfigType) => string;
+
+/**
+ * 设置文件基本路径
+ * @param key
+ * @param baseUrl
+ */
+declare function setBaseAttachUrl(baseUrl: string): void;
+/**
+ * 获取文件基本路径
+ */
+declare function getBaseAttachUrl(): string;
+
+/**
+ * 千位分隔符
+ * @param num
+ */
+declare const toThousands: (num: number) => string | undefined;
+/**
+ * 货币格式化
+ * @param currency
+ * @param fraction
+ */
+declare const currencyFmt: (currency: NullOrUndefinable<number | bigint>, fraction?: number) => string;
+
+type VantUploadFileStatus = '' | 'uploading' | 'done' | 'failed'
+type AntdUploadFileStatus = 'removed' | 'uploading' | 'done' | 'error'
+type ElementPlusUploadFileStatus = 'ready' | 'uploading' | 'success' | 'fail'
+
+interface Resource {
+  /** origin */
+  group: string
+  id: string
+  name: string
+  uri: string
+  /** extend */
+  url?: string
+  size?: number
+  uid?: string
+  status?: VantUploadFileStatus | AntdUploadFileStatus | ElementPlusUploadFileStatus
+  /** vant */
+  objectUrl?: string
+  content?: string
+  isImage?: boolean
+  message?: string
+  deletable?: boolean
+  reupload?: boolean
+  /** antd */
+  fileName?: string
+  percent?: number
+  thumbUrl?: string
+  /** element-plus */
+  percentage?: number
+}
+
+/**
+ * 获取文件完整地址
+ * @param url
+ */
+declare const resUrl: (url: Undefinable<string>) => string | undefined;
+/**
+ * 统一文件字段内容
+ * @param resource
+ */
+declare const recoverFile: (resource: Resource) => {
+    url: string | undefined;
+    content: string | undefined;
+    uri: string;
+    status: string;
+    percent: number;
+    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;
+};
+/**
+ * 附件格式
+ * @param data
+ */
+declare const attachFmt: (data: NullOrUndefinable<MaybeArray<Resource>> | string) => {
+    url: string | undefined;
+    content: string | undefined;
+    uri: string;
+    status: string;
+    percent: number;
+    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;
+}[];
+
+/**
+ * 是否有意义的值
+ * @param val
+ */
+declare const isDef: <T>(val: T) => val is NonNullable<T>;
+/**
+ * 是否是数字或字符
+ * @param val
+ */
+declare const isNumeric: (val: Numeric) => val is string;
+/**
+ * 是否是需要的图片格式
+ * @param ext
+ */
+declare const checkImg: (ext?: string) => boolean;
+/**
+ * 是否是空值/空数组/空对象 null undefined '' [] {} Set Map
+ * @param val
+ */
+declare const isEmpty: (val: NullOrUndefinable<Numeric | boolean | Record<any, any> | Array<any> | Set<any> | Map<any, any>>) => boolean;
+/**
+ * 判断是否合法JSON字符串
+ * @param str
+ */
+declare const isJSONStr: (str: string) => boolean;
+/**
+ * 判断是否合法JSON数组字符串
+ * @param str
+ */
+declare const isArrStr: (str: string) => boolean;
+/**
+ * 判断是否有效的key
+ * @param {string | number | symbol} key 键名
+ * @param {object} object 对象
+ * @example
+ *
+ * ```ts
+ * const obj = { a: 1, b: 2 }
+ * isValidKey('a', obj) // true
+ * ```
+ * @returns {boolean} boolean
+ */
+declare const isValidKey: (key: string | number | symbol, object: object) => key is never;
+/**
+ * 是否是中国手机号
+ * @param val
+ */
+declare const isPhone: (val: NullOrUndefinable<Numeric>) => boolean;
+/**
+ * 是否是中国座机号
+ * @param val
+ */
+declare const isTel: (val: NullOrUndefinable<Numeric>) => boolean;
+/**
+ * 是否是邮箱
+ * @param val
+ */
+declare const isEmail: (val: NullOrUndefinable<string>) => boolean;
+/**
+ * 是否是身份证
+ * @param val 身份证号
+ */
+declare const isIdCard: (val: NullOrUndefinable<string>) => boolean;
+/**
+ * 包含非ASCII字符
+ * @param text
+ */
+declare const nonASCII: (text: string) => 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 isValidArrRes: (res: Res<any[]>, code?: number) => boolean;
+/**
+ * 校验接口分页返回内容
+ * @param res
+ * @param code
+ */
+declare const isValidPageRes: (res: PageRes, code?: number) => boolean;
+/**
+ * 校验文件类型
+ * 1. XXX/YYY 2. .xxx 3. XXX/* 4.*
+ * @param {File} file 需要校验的文件
+ * @param {string} type 文件类型, 与input.accept一致
+ */
+declare const isValidFileType: (file: File, type: string) => boolean;
+
+export { type NullOrUndefinable, type Nullable, type Numeric, type PageRes, type PageResData, type Res, type Undefinable, attachFmt, camel2Kebab, camel2Pascal, camel2Snake, camel2Title, checkImg, currencyFmt, dateDuration, dateFmt, filterObj, fixiOSInputAutoZoomIn, getBaseAttachUrl, getHostEnv, hideCardNo, hideEmail, hideFirstName, hideHead, hideMiddle, hideName, hidePhone, hideSurname, hideTail, hideThird, inBrowser, isArrStr, isDef, isEmail, isEmpty, isIdCard, isJSONStr, isNumeric, isPhone, isTel, isValidArrRes, isValidFileType, isValidKey, isValidPageRes, isValidRes, isValidResCode, jClear, jDebug, jError, jGroup, jGroupC, jGroupE, jInfo, jLog, jTime, jTimeEnd, jWarn, kebab2Camel, kebab2Pascal, kebab2Snake, kebab2Title, nonASCII, parseToJSON, pascal2Camel, pascal2Kebab, pascal2Snake, pascal2Title, recoverFile, replacer, resUrl, reviver, setBaseAttachUrl, snake2Camel, snake2Kebab, snake2Pascal, snake2Title, title2Camel, title2Kebab, title2Pascal, title2Snake, toThousands, userAgent, waitTime };