Pillar Utils 是一个基于 TypeScript 开发的工具函数库，提供了一系列常用的工具函数，包括日期处理、正则表达式、数字格式化、对象操作和枚举处理等功能。该库旨在提高开发效率，减少重复代码，提供统一的工具函数接口。
Pillar Utils 是一个基于 TypeScript 开发的工具函数库，提供了一系列常用的工具函数，包括日期处理、正则表达式、数字格式化、对象操作和枚举处理等功能。该库旨在提高开发效率，减少重复代码，提供统一的工具函数接口。
- 📦 模块化设计：每个功能模块独立，可按需引入
- 🔒 类型安全：基于 TypeScript，提供完整的类型定义
- 🧪 全面测试：使用 Jest 进行单元测试，确保代码质量
- 📚 详细文档：每个模块都有详细的使用文档和示例
- 🌳 轻量级：依赖少，体积小，性能高
``bash`
npm install pillar-utils或
yarn add pillar-utils或
pnpm add pillar-utils
`typescript
// 引入日期工具
import { dateUtils } from 'pillar-utils';
const { formatDate } = dateUtils;
// 引入正则工具
import { regularUtils } from 'pillar-utils';
const { regularValid } = regularUtils;
// 引入数字工具
import { numberUtils } from 'pillar-utils';
const { thousandSeparator } = numberUtils;
// 引入对象工具
import { objectUtils } from 'pillar-utils';
const { deepCopy, emptyToNull } = objectUtils;
// 引入枚举工具
import { enumUtils } from 'pillar-utils';
const { create, getEnumOptions } = enumUtils;
// 引入文件工具
import { fileUtils } from 'pillar-utils';
const { formatSize, downloadFileStream, downloadStreamData } = fileUtils;
`
`typescript
import * as utils from 'pillar-utils';
// 使用日期工具
utils.dateUtils.formatDate(new Date());
// 使用正则工具
utils.regularUtils.regularValid('13800138000', 'phone');
// 使用数字工具
utils.numberUtils.thousandSeparator(1234567.89);
// 使用对象工具
utils.objectUtils.deepCopy({ name: 'test' });
// 使用枚举工具
utils.enumUtils.create([
{ value: 'ACTIVE', label: '活跃' },
{ value: 'INACTIVE', label: '非活跃' }
]);
// 使用文件工具
utils.fileUtils.formatSize(1024);
utils.fileUtils.downloadFileStream(blobData, 'example.pdf', 'application/pdf');
// 在异步函数中使用downloadStreamData
async function downloadFile() {
const success = await utils.fileUtils.downloadStreamData(response, 'example.pdf');
if (success) {
console.log('下载成功');
} else {
console.log('下载失败');
}
}
`
Pillar Utils 包含以下五个主要模块，每个模块都有详细的文档和示例：
提供日期处理相关的工具函数，基于 dayjs 库构建，包括日期格式化、日期范围处理、相对时间计算等功能。
主要功能：
- 日期格式化
- 日期范围处理
- 相对时间计算
- 时间戳转换
提供正则表达式处理相关的工具函数，包括常用正则表达式维护、获取正则表达式和正则校验等功能。
主要功能：
- 手机号验证
- 邮箱验证
- 正则表达式管理
- 正则验证工具
提供数字处理相关的工具函数，目前主要包含数字千分位格式化功能。
主要功能：
- 数字千分位格式化
- 小数位数控制
提供对象处理相关的工具函数，包括对象深拷贝、空值处理、数据检查等功能。
主要功能：
- 对象深拷贝
- 空值处理
- 数据检查
- 对象清理
提供枚举处理相关的工具函数，包括枚举创建、枚举值获取、枚举标签获取等功能。
主要功能：
- 枚举创建
- 枚举值获取
- 枚举标签获取
- 枚举选项生成
提供文件处理相关的工具函数，包括文件大小格式化和文件流下载功能。
主要功能：
- 文件大小格式化
- 文件流下载
- 浏览器兼容性处理
- Node.js >= 14
- TypeScript >= 4.0
`bash`
npm install或
yarn install或
pnpm install
`bash启动监听模式
npm run watch
$3
bash
构建所有模块
npm run build构建 ESM 模块
npm run build:esm构建 CommonJS 模块
npm run build:cjs清理构建产物
npm run clean
`$3
bash
运行 ESLint 检查
npm run lint
``欢迎提交 Issue 和 Pull Request 来帮助改进 Pillar Utils。