cmpt-huitu-utils
v2.0.2
Published
慧图前端通用工具库,包含常用的工具函数、正则校验、缓存管理、权限控制等功能。
Readme
@huitu/utils
慧图前端通用工具库,包含常用的工具函数、正则校验、缓存管理、权限控制等功能。
📦 安装
在 Monorepo 项目中,该包通常已经作为依赖安装。
🛠 核心模块
1. 缓存管理 (cache)
统一封装 localStorage 和 sessionStorage 操作,支持 JSON 对象直接存储。
import { cache } from 'cmpt-huitu-utils'
// SessionStorage 操作
cache.session.set('key', 'value')
const user = cache.session.getJSON('userInfo')
// LocalStorage 操作
cache.local.set('token', 'xxx')
cache.local.setJSON('settings', { theme: 'dark' })2. 消息提示 (modal)
统一封装 Element Plus 的消息反馈组件,简化调用方式。
import { modal } from 'cmpt-huitu-utils'
// 消息提示
modal.msgSuccess('操作成功')
modal.msgError('操作失败')
// 确认框
modal.confirm('确认删除吗?').then(() => {
// ...
})
// Loading
modal.loading('加载中...')
modal.closeLoading()3. 通用工具函数 (utils)
包含大量常用的业务工具函数。
import {
generateUUID,
treeToArray,
dateFormatFn,
deepClone
} from 'cmpt-huitu-utils'
// 生成 UUID
const id = generateUUID()
// 树形转数组
const list = treeToArray(treeData)
// 时间格式化
const timeStr = dateFormatFn(timestamp)
// 深拷贝
const newObj = deepClone(obj)4. 正则校验 (regular/validate)
常用的表单校验正则表达式函数。
import {
isPhone,
isEmail,
isExternal
} from 'cmpt-huitu-utils'
if (isPhone('13800138000')) {
// ...
}5. 认证与权限 (auth)
封装 Token 和用户信息的存取操作。
import {
getToken,
setToken,
getUserInfo
} from 'cmpt-huitu-utils'
const token = getToken()
const userInfo = getUserInfo()📚 完整 API 列表
Utils (通用工具)
generateUUID: 生成 UUIDtreeToArray: 树形结构平铺getFlatArr: 多维数组转一维copyToClipboard: 复制到剪贴板randomData: 生成随机数numberToCurrencyNo: 数字转千分位sizeFormat: 文件大小格式化downloadFileForm: 表单方式下载文件getBigMD5: 获取大文件 MD5
Regular (正则校验)
isPhone: 手机号校验isEmail: 邮箱校验isExternal: 是否为外链longitude: 经度校验latitude: 纬度校验specialCharacter: 特殊字符校验
Modal (交互反馈)
msg,msgSuccess,msgError,msgWarningalert,alertSuccess,alertErrornotify,notifySuccess,notifyErrorconfirm,promptloading,closeLoading
Cache (缓存)
session:set,get,setJSON,getJSON,removelocal:set,get,setJSON,getJSON,remove
