@longmo-utils/common
Variables
| Variable | Description |
|---|---|
| _version | 工具箱版本 |
Functions
| Function | Description |
|---|---|
| getDayjs | 异步获取 Dayjs 实例(已配置中文本地化和季度插件) 这是一个懒加载导入,避免将 dayjs 作为直接依赖 |
| getDayjsSync | 同步获取 Dayjs 实例(仅用于测试环境) 使用 ESM 动态导入,配合 vitest setupFiles 预加载使用 |
| getNumeral | 异步获取 Numeral 实例(已配置中文本地化) 这是一个懒加载导入,避免将 numeral 作为直接依赖 |
| getNumeralSync | 同步获取 Numeral 实例(仅用于测试环境) 使用 ESM 动态导入,配合 vitest setupFiles 预加载使用 |
| convertChineseNumber | 阿拉伯数字转中文数字 |
| convertCurrency | 阿拉伯数字换成汉字大写金额 |
| format | 通用格式化,需要手动指定格式 |
| formatMoney | 金额格式化 |
| formatNumber | 数字格式化 |
| formatPercentage | 百分比格式化 |
| getFormatStr | 快速生成numeraljs格式字符串, 处理千分位和小数位,可以继续使用format方法进行格式化,小数位处理方式四舍五入 |
| toFixed | 数字格式化,指定需要保留的小数位数,解决部分浏览器兼容性问题,如(0.615).toFixed(2) === '0.61'); |
| unformat | 反格式化,自动识别格式 |
| chunk | 将数组拆分成指定大小的子数组 |
| groupBy | 根据键函数对数组元素进行分组 |
| unique | 数组工具函数 |
| uniqueByField | 根据指定字段对对象数组进行去重 |
| isDarkColor | - |
| isLightColor | - |
| convertToHsl | 将颜色转换为HSL格式。 |
| convertToHslCssVar | 将颜色转换为HSL CSS变量。 |
| convertToRgb | 将颜色转换为RGB颜色字符串 TinyColor无法处理hsl内包含'deg'、'grad'、'rad'或'turn'的字符串 比如 hsl(231deg 98% 65%)将被解析为rgb(0, 0, 0) 这里在转换之前先将这些单位去掉 |
| isValidColor | 检查颜色是否有效 |
| generatorColorVariables | - |
| getSystemTimezone | 获取当前时区 |
| setCurrentTimezone | 设置默认时区 |
| getCurrentTimezone | 获取设置的时区 |
| formatDate | 格式化日期 |
| formatDateTime | 格式化日期时间 |
| isDateInstance | 检查值是否为 Date 实例 |
| isDayjsObject | 检查值是否为 dayjs 对象 |
| debounce | 防抖函数,延迟执行函数 |
| memoize | 创建函数的记忆化版本,缓存函数结果 |
| partial | 创建偏函数,预设部分参数 |
| throttle | 节流函数,限制函数执行频率 |
| deepClone | 深度克隆一个对象 |
| deepEqual | 深度比较两个对象是否相等 |
| deepMerge | 深度合并多个对象 |
| get | 通过路径字符串获取对象的嵌套值 |
| set | 通过路径字符串设置对象的嵌套值 |
| camelCase | 将字符串转换为驼峰命名 |
| capitalize | 将字符串首字母大写 |
| isEmpty | 检查字符串是否为空或只包含空白字符 |
| kebabCase | 将字符串转换为短横线命名 |
| random | 生成指定长度的随机字符串 |
| safeJsonStringify | 安全的json序列化,只对object和array进行转换,其他原样返回 |
| safeParseJson | 安全的JSON字符串解析 |
| snakeCase | 将字符串转换为下划线命名 |
| truncate | 截断字符串到指定长度 |
| filterTree | 根据条件过滤给定树结构的节点 |
| mapTree | 根据条件重新映射给定树结构的节点 |
| sortTree | 对树形结构数据进行递归排序 |
| traverseTreeValues | 遍历树形结构,并返回所有节点中指定的值 |
| parseQueryString | 解析URL查询字符串,转换成JSON格式 |
| querystringify | querystring转换成对象 |
| urlParse | url解析,在URL基础上扩展了查询字符串解析对象 |
| isArray | 是否是数组 |
| isBoolean | 是否是布尔值 |
| isDate | 是否是日期对象 |
| isEmptyObject | 是否是空对象 |
| isError | 是否是错误对象 |
| isFunction | 是否是函数 |
| isMap | 是否是Map |
| isNil | 检测value是否是null或undefined |
| isNull | 是否是null |
| isNumber | 是否是数字 |
| isObject | 是否是对象 |
| isPromise | 是否是Promise |
| isRegExp | 是否是正则 |
| isSet | 是否是Set |
| isString | 是否是字符串 |
| isSymbol | 是否是符号 |
| isTypeOf | 安全的类型检查 |
| isUndefined | 是否是undefined |
Classes
| Class | Description |
|---|---|
| TinyColor | - |
Interfaces
| Interface | Description |
|---|---|
| TreeConfigOptions | 树形配置选项接口 |
| IURL | urlParse 解析返回类型 |
Type Aliases
| Type Alias | Description |
|---|---|
| FormatDate | 日期输入类型 |
| Format | 日期格式类型 |
| jsonType | - |