ly-utils-lib 1.0.12 → 2.4.0

package/dist/index-B80SEVzM.d.cts

@@ -0,0 +1,382 @@
+import { DebouncedFunction, ThrottledFunction, debounce, throttle } from 'es-toolkit';
+
+/**
+ * 通用工具模块
+ * 提供颜色转换、图片处理、文件下载、类型判断、数组/对象操作等通用功能
+ */
+
+/**
+ * 深度克隆对象
+ * @param obj 要克隆的对象
+ * @returns 克隆后的对象
+ */
+declare const clone: <T>(obj: T) => T;
+/**
+ * 深度比较两个对象是否相等
+ * @param a 对象 a
+ * @param b 对象 b
+ * @returns 是否相等
+ */
+declare const isEqual: (a: any, b: any) => boolean;
+/**
+ * 深度合并对象
+ * @param objects 要合并的对象
+ * @returns 合并后的对象
+ */
+declare const deepMerge: <T extends Record<string, any>>(...objects: Partial<T>[]) => T;
+/**
+ * 获取对象的路径值
+ * @param obj 对象
+ * @param path 路径（例如：'user.name'）
+ * @returns 路径对应的值
+ */
+declare const get: (obj: any, path: string) => any;
+/**
+ * 设置对象的路径值
+ * @param obj 对象
+ * @param path 路径（例如：'user.name'）
+ * @param value 要设置的值
+ */
+declare const set: (obj: any, path: string, value: any) => void;
+/**
+ * 省略对象中的某些属性
+ * @param obj 对象
+ * @param keys 要省略的键
+ * @returns 省略后的对象
+ */
+declare const omit: <T extends Record<string, any>, K extends keyof T>(obj: T, keys: K[]) => Omit<T, K>;
+/**
+ * 选择对象中的某些属性
+ * @param obj 对象
+ * @param keys 要选择的键
+ * @returns 选择后的对象
+ */
+declare const pick: <T extends Record<string, any>, K extends keyof T>(obj: T, keys: K[]) => Pick<T, K>;
+/**
+ * 判断是否为对象
+ * @param value 要判断的值
+ * @returns 是否为对象
+ */
+declare const isObject: (value: any) => value is Record<string, any>;
+/**
+ * 判断是否为数组
+ * @param value 要判断的值
+ * @returns 是否为数组
+ */
+declare const isArray: (value: any) => value is any[];
+/**
+ * 判断是否为字符串
+ * @param value 要判断的值
+ * @returns 是否为字符串
+ */
+declare const isString: (value: any) => value is string;
+/**
+ * 判断是否为数字
+ * @param value 要判断的值
+ * @returns 是否为数字
+ */
+declare const isNumber: (value: any) => value is number;
+/**
+ * 判断是否为布尔值
+ * @param value 要判断的值
+ * @returns 是否为布尔值
+ */
+declare const isBoolean: (value: any) => value is boolean;
+/**
+ * 判断是否为函数
+ * @param value 要判断的值
+ * @returns 是否为函数
+ */
+declare const isFunction: (value: any) => value is Function;
+/**
+ * 判断是否为空值
+ * @param value 要判断的值
+ * @returns 是否为空
+ */
+declare const isEmpty: (value: any) => boolean;
+/**
+ * 数组去重
+ * @param array 数组
+ * @returns 去重后的数组
+ */
+declare const uniq: <T>(array: T[]) => T[];
+/**
+ * 数组排序
+ * @param array 数组
+ * @param key 排序键
+ * @returns 排序后的数组
+ */
+declare const sortBy: <T>(array: T[], key: keyof T | ((item: T) => any)) => T[];
+/**
+ * 数组分块
+ * @param array 数组
+ * @param size 分块大小
+ * @returns 分块后的二维数组
+ */
+declare const chunk: <T>(array: T[], size: number) => T[][];
+/**
+ * 数组分组
+ * @param array 数组
+ * @param key 分组键
+ * @returns 分组后的对象
+ */
+declare const groupBy: <T>(array: T[], key: keyof T | ((item: T) => string)) => Record<string, T[]>;
+/**
+ * 数组求和
+ * @param array 数组
+ * @returns 总和
+ */
+declare const sum: (array: number[]) => number;
+/**
+ * 数组平均值
+ * @param array 数组
+ * @returns 平均值
+ */
+declare const avg: (array: number[]) => number;
+/**
+ * 数组最大值
+ * @param array 数组
+ * @returns 最大值
+ */
+declare const max: (array: number[]) => number;
+/**
+ * 数组最小值
+ * @param array 数组
+ * @returns 最小值
+ */
+declare const min: (array: number[]) => number;
+/**
+ * 驼峰转下划线
+ * @param str 字符串
+ * @returns 转换后的字符串
+ */
+declare const camelToSnake: (str: string) => string;
+/**
+ * 下划线转驼峰
+ * @param str 字符串
+ * @returns 转换后的字符串
+ */
+declare const snakeToCamel: (str: string) => string;
+/**
+ * 首字母大写
+ * @param str 字符串
+ * @returns 转换后的字符串
+ */
+declare const capitalize: (str: string) => string;
+/**
+ * 截断字符串
+ * @param str 字符串
+ * @param length 最大长度
+ * @param suffix 后缀
+ * @returns 截断后的字符串
+ */
+declare const truncate: (str: string, length?: number, suffix?: string) => string;
+/**
+ * 格式化文件大小
+ * @param bytes 字节数
+ * @returns 格式化后的字符串
+ */
+declare const formatFileSize: (bytes: number) => string;
+/**
+ * 格式化数字（千分位）
+ * @param num 数字
+ * @returns 格式化后的字符串
+ */
+declare const formatNumber: (num: number) => string;
+/**
+ * 检查是否为有效的 URL
+ * @param str 字符串
+ * @returns 是否为有效 URL
+ */
+declare const isValidUrl: (str: string) => boolean;
+/**
+ * 检查是否为有效的邮箱
+ * @param email 邮箱地址
+ * @returns 是否为有效邮箱
+ */
+declare const isValidEmail: (email: string) => boolean;
+/**
+ * 检查是否为有效的手机号（中国）
+ * @param phone 手机号
+ * @returns 是否为有效手机号
+ */
+declare const isValidPhone: (phone: string) => boolean;
+/**
+ * 生成范围内的随机整数
+ * @param min 最小值
+ * @param max 最大值
+ * @returns 随机整数
+ */
+declare const randomInt: (min: number, max: number) => number;
+/**
+ * 生成唯一 ID
+ * @param prefix 前缀
+ * @returns 唯一 ID
+ */
+declare const uniqueId: (prefix?: string) => string;
+/**
+ * 延迟执行
+ * @param ms 延迟时间（毫秒）
+ * @returns Promise
+ */
+declare const delay: (ms: number) => Promise<void>;
+/**
+ * 重试函数
+ * @param fn 要执行的函数
+ * @param retries 重试次数
+ * @param delayMs 重试延迟
+ * @returns Promise
+ */
+declare const retry: <T>(fn: () => Promise<T>, retries?: number, delayMs?: number) => Promise<T>;
+/**
+ * Hex 颜色转 RGB 颜色
+ * @param str Hex 颜色（如 #FFFFFF 或 FFFFFF）
+ * @returns RGB 颜色数组 [r, g, b]
+ */
+declare const hexToRgb: (str: string) => number[] | null;
+/**
+ * Hex 颜色转 RGB 字符串
+ * @param str Hex 颜色（如 #FFFFFF 或 FFFFFF）
+ * @returns RGB 字符串（如 rgb(255, 255, 255)）
+ */
+declare const hexToRgbString: (str: string) => string | null;
+/**
+ * RGB 颜色转 Hex 颜色
+ * @param r 红色值 (0-255)
+ * @param g 绿色值 (0-255)
+ * @param b 蓝色值 (0-255)
+ * @returns Hex 颜色字符串（如 #FFFFFF）
+ */
+declare const rgbToHex: (r: number, g: number, b: number) => string | null;
+/**
+ * RGB 颜色转 Hex 颜色（数组版本）
+ * @param rgb RGB 数组 [r, g, b]
+ * @returns Hex 颜色字符串（如 #FFFFFF）
+ */
+declare const rgbArrayToHex: (rgb: number[]) => string | null;
+/**
+ * 变浅颜色值
+ * @param color Hex 颜色（如 #FFFFFF 或 FFFFFF）
+ * @param alpha 透明度因子 (0-1)，值越大颜色越浅
+ * @returns 变浅后的 Hex 颜色
+ */
+declare const getLightColor: (color: string, alpha: number) => string | null;
+/**
+ * 变深颜色值
+ * @param color Hex 颜色（如 #FFFFFF 或 FFFFFF）
+ * @param alpha 暗化因子 (0-1)，值越大颜色越深
+ * @returns 变深后的 Hex 颜色
+ */
+declare const getDarkColor: (color: string, alpha: number) => string | null;
+/**
+ * 图片转 Base64
+ * @param url 图片 URL
+ * @param type 图片类型（默认 image/png）
+ * @returns Base64 字符串
+ */
+declare const imgToBase64: (url: string, type?: "image/jpeg" | "image/png") => Promise<string>;
+/**
+ * Base64 转 File 对象
+ * @param base64 Base64 字符串
+ * @param fileName 文件名
+ * @param mimeType MIME 类型（默认 image/jpeg）
+ * @returns File 对象
+ */
+declare const base64toFile: (base64: string, fileName: string, mimeType?: string) => File;
+/**
+ * Base64 转 Blob 对象
+ * @param base64 Base64 字符串
+ * @param mimeType MIME 类型
+ * @returns Blob 对象
+ */
+declare const base64toBlob: (base64: string, mimeType?: string) => Blob;
+/**
+ * 下载文件
+ * @param url 文件 URL 或 Data URL
+ * @param fileName 文件名
+ * @param target 是否在新标签页打开（默认 false）
+ */
+declare const downloadFile: (url: string, fileName?: string, target?: boolean) => void;
+/**
+ * 下载 Blob 文件
+ * @param blob Blob 对象
+ * @param fileName 文件名
+ */
+declare const downloadBlob: (blob: Blob, fileName: string) => void;
+/**
+ * 下载 Base64 文件
+ * @param base64 Base64 字符串
+ * @param fileName 文件名
+ * @param mimeType MIME 类型
+ */
+declare const downloadBase64: (base64: string, fileName: string, mimeType?: string) => void;
+/**
+ * 复制文本到剪贴板
+ * @param text 要复制的文本
+ * @returns 是否成功
+ */
+declare const copyToClipboard: (text: string) => Promise<boolean>;
+/**
+ * 从剪贴板读取文本
+ * @returns 剪贴板文本
+ */
+declare const readFromClipboard: () => Promise<string>;
+
+declare const index_DebouncedFunction: typeof DebouncedFunction;
+declare const index_ThrottledFunction: typeof ThrottledFunction;
+declare const index_avg: typeof avg;
+declare const index_base64toBlob: typeof base64toBlob;
+declare const index_base64toFile: typeof base64toFile;
+declare const index_camelToSnake: typeof camelToSnake;
+declare const index_capitalize: typeof capitalize;
+declare const index_chunk: typeof chunk;
+declare const index_clone: typeof clone;
+declare const index_copyToClipboard: typeof copyToClipboard;
+declare const index_debounce: typeof debounce;
+declare const index_deepMerge: typeof deepMerge;
+declare const index_delay: typeof delay;
+declare const index_downloadBase64: typeof downloadBase64;
+declare const index_downloadBlob: typeof downloadBlob;
+declare const index_downloadFile: typeof downloadFile;
+declare const index_formatFileSize: typeof formatFileSize;
+declare const index_formatNumber: typeof formatNumber;
+declare const index_get: typeof get;
+declare const index_getDarkColor: typeof getDarkColor;
+declare const index_getLightColor: typeof getLightColor;
+declare const index_groupBy: typeof groupBy;
+declare const index_hexToRgb: typeof hexToRgb;
+declare const index_hexToRgbString: typeof hexToRgbString;
+declare const index_imgToBase64: typeof imgToBase64;
+declare const index_isArray: typeof isArray;
+declare const index_isBoolean: typeof isBoolean;
+declare const index_isEmpty: typeof isEmpty;
+declare const index_isEqual: typeof isEqual;
+declare const index_isFunction: typeof isFunction;
+declare const index_isNumber: typeof isNumber;
+declare const index_isObject: typeof isObject;
+declare const index_isString: typeof isString;
+declare const index_isValidEmail: typeof isValidEmail;
+declare const index_isValidPhone: typeof isValidPhone;
+declare const index_isValidUrl: typeof isValidUrl;
+declare const index_max: typeof max;
+declare const index_min: typeof min;
+declare const index_omit: typeof omit;
+declare const index_pick: typeof pick;
+declare const index_randomInt: typeof randomInt;
+declare const index_readFromClipboard: typeof readFromClipboard;
+declare const index_retry: typeof retry;
+declare const index_rgbArrayToHex: typeof rgbArrayToHex;
+declare const index_rgbToHex: typeof rgbToHex;
+declare const index_set: typeof set;
+declare const index_snakeToCamel: typeof snakeToCamel;
+declare const index_sortBy: typeof sortBy;
+declare const index_sum: typeof sum;
+declare const index_throttle: typeof throttle;
+declare const index_truncate: typeof truncate;
+declare const index_uniq: typeof uniq;
+declare const index_uniqueId: typeof uniqueId;
+declare namespace index {
+  export { index_DebouncedFunction as DebouncedFunction, index_ThrottledFunction as ThrottledFunction, index_avg as avg, index_base64toBlob as base64toBlob, index_base64toFile as base64toFile, index_camelToSnake as camelToSnake, index_capitalize as capitalize, index_chunk as chunk, index_clone as clone, index_copyToClipboard as copyToClipboard, index_debounce as debounce, index_deepMerge as deepMerge, index_delay as delay, index_downloadBase64 as downloadBase64, index_downloadBlob as downloadBlob, index_downloadFile as downloadFile, index_formatFileSize as formatFileSize, index_formatNumber as formatNumber, index_get as get, index_getDarkColor as getDarkColor, index_getLightColor as getLightColor, index_groupBy as groupBy, index_hexToRgb as hexToRgb, index_hexToRgbString as hexToRgbString, index_imgToBase64 as imgToBase64, index_isArray as isArray, index_isBoolean as isBoolean, index_isEmpty as isEmpty, index_isEqual as isEqual, index_isFunction as isFunction, index_isNumber as isNumber, index_isObject as isObject, index_isString as isString, index_isValidEmail as isValidEmail, index_isValidPhone as isValidPhone, index_isValidUrl as isValidUrl, index_max as max, index_min as min, index_omit as omit, index_pick as pick, index_randomInt as randomInt, index_readFromClipboard as readFromClipboard, index_retry as retry, index_rgbArrayToHex as rgbArrayToHex, index_rgbToHex as rgbToHex, index_set as set, index_snakeToCamel as snakeToCamel, index_sortBy as sortBy, index_sum as sum, index_throttle as throttle, index_truncate as truncate, index_uniq as uniq, index_uniqueId as uniqueId };
+}
+
+export { isEqual as A, isFunction as B, isNumber as C, isObject as D, isString as E, isValidEmail as F, isValidPhone as G, isValidUrl as H, max as I, min as J, omit as K, pick as L, randomInt as M, readFromClipboard as N, retry as O, rgbArrayToHex as P, rgbToHex as Q, set as R, snakeToCamel as S, sortBy as T, sum as U, truncate as V, uniq as W, uniqueId as X, avg as a, base64toBlob as b, base64toFile as c, camelToSnake as d, capitalize as e, chunk as f, clone as g, copyToClipboard as h, index as i, deepMerge as j, delay as k, downloadBase64 as l, downloadBlob as m, downloadFile as n, formatFileSize as o, formatNumber as p, get as q, getDarkColor as r, getLightColor as s, groupBy as t, hexToRgb as u, hexToRgbString as v, imgToBase64 as w, isArray as x, isBoolean as y, isEmpty as z };