@clare-hjh/utils

一个实用的 JavaScript/TypeScript 工具函数库，提供常用的类型判断、文件操作、DOM操作、表单验证等功能。

📦 安装

npm install @clare-hjh/utils

或者使用 yarn：

yarn add @clare-hjh/utils

或者使用 pnpm：

pnpm add @clare-hjh/utils

🚀 使用

ES6 模块导入

import { isString, debounce, throttle, checkPhoneNumber } from '@clare-hjh/utils';

CommonJS 导入

const { isString, debounce, throttle, checkPhoneNumber } = require('@clare-hjh/utils');

📚 功能模块

类型判断 (is)

• is() - 通用类型判断
• isString() - 判断是否为字符串
• isNumber() - 判断是否为数字
• isBoolean() - 判断是否为布尔值
• isArray() - 判断是否为数组
• isObject() - 判断是否为对象
• isFunction() - 判断是否为函数
• isDate() - 判断是否为日期
• isPromise() - 判断是否为Promise
• isAsyncFunction() - 判断是否为异步函数
• isElement() - 判断是否为DOM元素
• isClient() - 判断是否为客户端环境
• isWindow() - 判断是否为Window对象
• isHexColor() - 判断是否为16进制颜色
• isDef() / isUnDef() - 判断是否已定义/未定义
• isNull() / isNullOrUnDef() - 判断是否为null或undefined

文件操作 (file)

• isImageFile() - 判断是否为图片文件
• isDocumentFile() - 判断是否为文档文件
• getFileExtension() - 获取文件扩展名
• getFileNameWithoutExtension() - 获取不带扩展名的文件名
• getAssetUrl() - 生成Vite项目中静态资源的路径

DOM操作 (dom)

• getElementPosition() - 获取元素相对于文档的坐标
• scrollToTop() - 平滑滚动到页面顶部

下载功能 (download)

• DownloadFile() - 文件下载功能

性能优化

• debounce() - 防抖函数
• throttle() - 节流函数

表单验证 (eleValidate)

• checkPhoneNumber() - 手机号验证（必填）
• validateSimplePhone() - 手机号验证（非必填）
• validateSimpleIdCard() - 身份证号验证（非必填）
• validatePassword() - 密码验证
• passwordReg - 密码正则表达式

其他工具

• checkForUpdate() - 检查应用更新
• errorHandler - 全局错误处理

📖 详细文档

查看完整的API文档：文档地址

🤝 贡献

欢迎提交 Issue 和 Pull Request！

📄 许可证

MIT License