@lntvow/utils 3.0.2 → 3.0.6

package/dist/index.d.cts

@@ -0,0 +1,431 @@
+/**
+ * @description 将非数组转换为数组 如果是目标本就是数组则直接返回
+ * @param target 目标
+ * @example castArray(1) => [1]
+ */
+declare function castArray<T>(target: T | T[]): T[];
+
+/**
+ * @description compose
+ * @param fns 任意函数
+ */
+declare function compose(...fns: ((...args: any[]) => any)[]): (...args: any[]) => any;
+/**
+ * @description compose 从右到左
+ * @param fns 任意函数
+ */
+declare function composeRight(...fns: ((...args: any[]) => any)[]): (...args: any[]) => any;
+
+/**
+ * @description 防抖函数
+ * @param target 目标函数
+ * @param wait 等待时间 默认 500ms
+ * @example debounce(() => console.log('debounce'), 500)
+ */
+declare function debounce(target: Function, wait?: number): (...args: any[]) => void;
+
+/**
+ * @description 深拷贝
+ * @param target 拷贝对象
+ * @example deepClone({ name: 1, obj: { name: 1 }, arr: [1, 2, 3] }) => { name: 1, obj: { name: 1 }, arr: [1, 2, 3] }
+ */
+declare function deepClone<T>(target: T): T;
+
+type AnyObject = Record<string, any>;
+type ArrayItem<T> = T extends (infer U)[] ? U : never;
+declare const objectToString: () => string;
+declare const toTypeString: (value: unknown) => string;
+declare function initLog(cb: Function): void;
+declare const log: (name: unknown, ...arg: unknown[]) => void;
+declare const warn: (...arg: unknown[]) => void;
+declare const error: (...arg: unknown[]) => void;
+declare const isMap: (val: unknown) => val is Map<any, any>;
+declare const isSet: (val: unknown) => val is Set<any>;
+declare const isDate: (val: unknown) => val is Date;
+declare const isRegExp: (val: unknown) => val is RegExp;
+declare const isFunction: (val: unknown) => val is Function;
+declare const isNumber: (val: unknown) => val is number;
+declare const isString: (val: unknown) => val is string;
+declare const isSymbol: (val: unknown) => val is symbol;
+declare const isObject: (val: unknown) => val is Record<any, any>;
+declare const isPromise: <T = any>(val: unknown) => val is Promise<T>;
+declare const isUndef: (val: unknown) => val is null | undefined;
+declare const isUndefined: (val: unknown) => val is undefined;
+declare const isNull: (val: unknown) => val is null;
+declare const isDef: <T>(val: T) => val is NonNullable<T>;
+declare const isBoolean: (val: unknown) => val is boolean;
+declare const isArray: (arg: any) => arg is any[];
+declare const hasOwn: <T extends object, U extends keyof T>(target: T, key: U) => boolean;
+declare const hasChanged: (oldValue: unknown, newValue: unknown) => boolean;
+type Arrayable<T> = T | T[];
+
+interface DeepMergeOptions {
+    /**
+     * @description 是否开启深拷贝 默认开启
+     * @default true
+     */
+    deepClone: boolean;
+}
+/**
+ * @description 深度合并两对象
+ * @param template 模板对象 就是默认值
+ * @param source 源对象 就是用户传入的值
+ * @param options 配置对象
+ * @example deepMerge({ name: 1, obj: { name: '默认' , text: '旧值' }, arr: [1, 2, 3] }, { name: 1, obj: { name: '修改', age: '新增' }, test: 'test' }) => { name: 1, obj: { name: '修改', text: '旧值', age: '新增' }, arr: [1, 2, 3], test: 'test' }
+ */
+declare function deepMerge(template: AnyObject, source: AnyObject, options?: DeepMergeOptions): any;
+
+declare function throwError(scope: string, message: string): void;
+declare function debugWarn(err: Error): void;
+declare function debugWarn(scope: string, message: string): void;
+declare const deprecated: ({ from, replacement, version, type, }: {
+    from: string;
+    replacement: string;
+    version: string;
+    type?: 'API';
+}) => void;
+
+/**
+ * @description 解析查询字符串
+ * @param str 转换的字符串
+ * @return 转换后的对象
+ * @example
+ * parse('a=1&b=2') => { a: '1', b: '2' }
+ * parse('?a=1&b=2') => { a: '1', b: '2' }
+ * parse('&a=1&b=2') => { a: '1', b: '2' }
+ * parse('from=%E4%B8%AD%E5%9B%BD') => { from: '中国' }
+ * parse('from=%E4%B8%AD%E5%9B%BD', { decode: false }) => { from: '%E4%B8%AD%E5%9B%BD' }
+ */
+declare function parse(str: string, options?: ParseOptions): Record<string, string>;
+/**
+ *@description 转换对象为查询字符串
+ * @param obj 转换的对象
+ * @return 转换后的字符串
+ * @example
+ * stringify({ a: '1', b: '2' }) => 'a=1&b=2'
+ * stringify({ from: '中国' }) => 'from=%E4%B8%AD%E5%9B%BD'
+ * stringify({ from: '中国' }, { encode: false }) => 'from=中国'
+ */
+declare function stringify(obj: Record<string, any>, options?: StringifyOptions): string;
+/**
+ * @description url追加查询字符串
+ * @param url url
+ * @param obj 查询字符串对象
+ * @return 追加后的url
+ * @example
+ * appendQueryString('https://www.baidu.com', { a: '1', b: '2' }) => 'https://www.baidu.com?a=1&b=2'
+ * appendQueryString('/pages/index?id=10', { test:'23' }) => '/pages/index?id=10&test=23'
+ */
+declare function appendQueryString(url: string, obj: AnyObject, options?: StringifyOptions): string;
+declare const qs: {
+    parse: typeof parse;
+    stringify: typeof stringify;
+    appendQueryString: typeof appendQueryString;
+};
+interface ParseOptions {
+    /**
+     * @description 是否解码
+     * @default true
+     */
+    decode?: boolean;
+}
+interface StringifyOptions {
+    /**
+     * @description 是否编码
+     * @default true
+     */
+    encode?: boolean;
+}
+
+/**
+ * @description 节流函数
+ * @param target 目标函数
+ * @param wait 等待时间 默认 500ms
+ * @example throttle(() => console.log('hello world'), 500)
+ */
+declare function throttle(target: Function, wait?: number): (...args: any[]) => any;
+
+/**
+ * @description 校验经纬度
+ */
+declare function validatorLatitudeOrLongitude(value: string): boolean;
+/**
+ * @description 校验中文、字母、数字
+ */
+declare function validatorChineseOrEnglishOrNumber(value: string): boolean;
+/**
+ * @description 校验中英文
+ */
+declare function validatorChineseOrEnglish(value: string): boolean;
+/**
+ * @description 校验大写字母、数字、特殊字符 特殊字符包括 !"#$%&'()*+,-./:;<=>?@[\]^_`{|}~
+ */
+declare function validatorUppercaseOrNumbersOrSpecial(value: string): boolean;
+/**
+ * @description 校验大写字母、数字、_
+ */
+declare function validatorUppercaseOrNumbersOrUnderline(value: string): boolean;
+/**
+ * @description 校验是否为邮箱
+ * @deprecated  使用 isEmail 代替
+ */
+declare function validatorEmail(value: string): boolean;
+
+declare function compareProperties(target: AnyObject, source: AnyObject): void | AnyObject;
+
+/**
+ * @description 排除对象中的某些属性
+ * @param target 目标对象
+ * @param properties 要排除的属性
+ * @example excludeProperties({ a: 1, b: 2, c: 3 }, ['a', 'b']) => { c: 3 }
+ */
+declare function excludeProperties<T extends AnyObject, K extends keyof T>(target: T, properties: Arrayable<K>): Omit<T, K>;
+/**
+ * @description 提取对象中的某些属性
+ * @param target 目标对象
+ * @param properties 要提取的属性
+ * @example extractProperties({ a: 1, b: 2, c: 3 }, ['a', 'b']) => { a: 1, b: 2 }
+ */
+declare function extractProperties<T extends AnyObject, K extends keyof T>(target: T, properties: Arrayable<K>): Pick<T, K>;
+
+/**
+ * @description 生成随机数组
+ * @example generateRandomArray(4, () => 1) => [1, 1, 1, 1]
+ * */
+declare function generateRandomArray<T>(num: number, cb: (item?: unknown, index?: number) => T): T[];
+
+/**
+ * @description 生成随机颜色
+ * @example generateRandomColor() => '#f36a38'
+ * */
+declare function generateRandomColor(): string;
+
+/**
+ * @description 生成随机时间
+ * @example generateRandomDate() => '2021-07-01 08:51:34'
+ * */
+declare function generateRandomDate(options?: GenerateRandomDate): string;
+interface GenerateRandomDate {
+    /**
+     * @description 开始时间
+     * @default 1800-01-01 00:00:00
+     */
+    start?: string | Date;
+    /**
+     * @description 结束时间
+     * @default 当前时间
+     */
+    end?: string | Date;
+    /**
+     * @description 时间格式
+     * @default YYYY-MM-DD HH:mm:ss
+     */
+    format?: string;
+}
+
+/**
+ * @description 生成随机邮箱
+ * @example generateRandomEmail() => lZtJqMl0dyTO3WDGzFDO@example.com
+ */
+declare function generateRandomEmail(): string;
+
+/**
+ * @description 生成范围内的随机浮点数
+ * @example generateRandomFloat() => 0.35
+ * */
+declare function generateRandomFloat(options?: GenerateRandomFloat): number;
+type GenerateRandomFloat = number | {
+    /**
+     * @description 最大值
+     * @default 1.00
+     */
+    max?: number;
+    /**
+     * @description 最小值
+     * @default 0.00
+     */
+    min?: number;
+    /**
+     * @description 小数位数
+     * @default  2
+     */
+    fractionDigits?: number;
+};
+
+/**
+ * @description 生成随机二代身份证号
+ * @example generateRandomIdCard() => '410304200210165258'
+ */
+declare function generateRandomIdCard(): string;
+
+/**
+ * @description 生成范围内的随机整数
+ * @example generateRandomInteger() => 217342
+ * */
+declare function generateRandomInteger(options?: GenerateRandomIntegerOptions): number;
+type GenerateRandomIntegerOptions = number | {
+    /**
+     * @description 最大值
+     * @default Number.MAX_SAFE_INTEGER
+     */
+    max?: number;
+    /**
+     * @description 最小值
+     * @default 0
+     */
+    min?: number;
+};
+
+/**
+ * @description 生成随机手机号码
+ * @example generateRandomMobilePhone() => 13012345678
+ */
+declare function generateRandomMobilePhone(): string;
+
+/**
+ * @description 生成随机字符串 大小写字母和数字
+ * @param length 返回字符串的长度
+ * @example generateRandomString(20) => 'lZtJqMl0dyTO3WDGzFDO'
+ * */
+declare function generateRandomString(length: number, options?: GenerateRandomStringOptions): string;
+interface GenerateRandomStringOptions {
+    /**
+     * @description 是否包含小写字母
+     * @default true
+     */
+    lowerCase?: boolean;
+    /**
+     * @description 是否包含大写字母
+     * @default true
+     */
+    upperCase?: boolean;
+    /**
+     * @description 是否包含数字
+     * @default true
+     */
+    number?: boolean;
+}
+
+/**
+ * @description 生成随机数据从数据源中
+ * @param num  随机获取数据源子项次数
+ * @example generateRandomStringFromSource(4, ['1', 'b', 'c', 'd', 'e']) => 'dea1'
+ * */
+declare function generateRandomStringFromSource(num: number, source: (number | string)[]): string;
+
+/**
+ * @description 获取数组中的随机元素
+ * @example  getRandomItem([0, 1, 2, 3, 4]) => 2
+ */
+declare function getRandomItem<T>(list: T[]): T;
+
+/**
+ * @description 校验是否为数字
+ */
+declare function isNumberOrNumberString(val: string): boolean;
+/**
+ * @description 校验是否为中文
+ */
+declare function isChinese(val: string): boolean;
+/**
+ * @description 校验是否为英文字母
+ */
+declare function isEnglishAphabet(val: string): boolean;
+/**
+ * @description 校验是否为大写字母
+ */
+declare function isUpperCase(val: string): boolean;
+/**
+ * @description 校验是否为大写字母和数字
+ */
+declare function isUpperCaseAndNumber(val: string): boolean;
+/**
+ * @description 校验是否为大写字母数字和中文
+ */
+declare function isUpperCaseAndNumberAndChinese(val: string): boolean;
+/**
+ * @description 校验是否为小写字母
+ */
+declare function isLowerCase(val: string): boolean;
+/**
+ * @description 校验是否为小写字母和数字
+ */
+declare function isLowerCaseAndNumber(val: string): boolean;
+/**
+ * @description 校验是否为小写字母数字和中文
+ */
+declare function isLowerCaseAndNumberAndChinese(val: string): boolean;
+
+/**
+ * @description 校验是否为浮点数
+ */
+declare function isFloat(val: string, floatOptions?: FloatOptions): boolean;
+/**
+ * @description 校验是否为大于零的浮点数
+ */
+declare function isPositiveFloat(val: string, floatOptions?: FloatOptions): boolean;
+/**
+ * @description 校验是否为小于零的浮点数
+ */
+declare function isNegativeFloat(val: string, floatOptions?: FloatOptions): boolean;
+/**
+ * @description 校验是否为大于等于零的浮点数
+ */
+declare function isPositiveFloatOrZero(val: string, floatOptions?: FloatOptions): boolean;
+/**
+ * @description 校验是否为小于等于零的浮点数
+ */
+declare function isNegativeFloatOrZero(val: string, floatOptions?: FloatOptions): boolean;
+interface FloatOptions {
+    /**
+     * @description 是否包括整数
+     * @default true
+     */
+    integer?: boolean;
+}
+
+/**
+ * @description 校验是否为整数
+ */
+declare function isInteger(val: string): boolean;
+/**
+ * @description 校验否为正整数
+ */
+declare function isPositiveInteger(val: string): boolean;
+/**
+ * @description 校验是否为大于等于零的整数
+ */
+declare function isPositiveIntegerOrZero(val: string): boolean;
+/**
+ * @description 校验是否为负整数
+ */
+declare function isNegativeInteger(val: string): boolean;
+/**
+ * @description 校验是否为小于等于零的整数
+ */
+declare function isNegativeIntegerOrZero(val: string): boolean;
+
+/**
+ * @description 校验是否为手机号
+ */
+declare function isMobilePhone(val: string): boolean;
+/**
+ * @description 校验是否为邮箱
+ */
+declare function isEmail(val: string): boolean;
+/**
+ * @description 校验是否为空字符串
+ */
+declare function isEmptyString(val: unknown): boolean;
+/**
+ * @description 校验是否为合法时间格式
+ * @param format 时间格式 默认 YYYY-MM-DD HH:mm:ss
+ * @link https://day.js.org/docs/zh-CN/parse/string-format
+ */
+declare function isDateString(val: string, format?: string): boolean;
+/**
+ * @description 校验是否为二代身份证号
+ */
+declare function isIdCard(val: string): boolean;
+
+export { type AnyObject, type ArrayItem, type Arrayable, type FloatOptions, type GenerateRandomDate, type GenerateRandomFloat, type GenerateRandomIntegerOptions, type GenerateRandomStringOptions, type ParseOptions, type StringifyOptions, castArray, compareProperties, compose, composeRight, debounce, debugWarn, deepClone, deepMerge, deprecated, error, excludeProperties, extractProperties, generateRandomArray, generateRandomColor, generateRandomDate, generateRandomEmail, generateRandomFloat, generateRandomIdCard, generateRandomInteger, generateRandomMobilePhone, generateRandomString, generateRandomStringFromSource, getRandomItem, hasChanged, hasOwn, initLog, isArray, isBoolean, isChinese, isDate, isDateString, isDef, isEmail, isEmptyString, isEnglishAphabet, isFloat, isFunction, isIdCard, isInteger, isLowerCase, isLowerCaseAndNumber, isLowerCaseAndNumberAndChinese, isMap, isMobilePhone, isNegativeFloat, isNegativeFloatOrZero, isNegativeInteger, isNegativeIntegerOrZero, isNull, isNumber, isNumberOrNumberString, isObject, isPositiveFloat, isPositiveFloatOrZero, isPositiveInteger, isPositiveIntegerOrZero, isPromise, isRegExp, isSet, isString, isSymbol, isUndef, isUndefined, isUpperCase, isUpperCaseAndNumber, isUpperCaseAndNumberAndChinese, log, objectToString, qs, throttle, throwError, toTypeString, validatorChineseOrEnglish, validatorChineseOrEnglishOrNumber, validatorEmail, validatorLatitudeOrLongitude, validatorUppercaseOrNumbersOrSpecial, validatorUppercaseOrNumbersOrUnderline, warn };