Skip to content

@pmun/utils

npm versionlicense

一个轻量级、模块化的 TypeScript 工具函数库,为日常开发提供便捷实用的工具集合。

访问全部 API 查看全部的 API,包含每个函数的说明、参数、返回值和使用示例。

特点

  • 🚀 轻量级:按需引入,不增加项目体积
  • 🧩 模块化:合理划分模块,易于使用和维护
  • 📦 零依赖:除日期处理外无外部依赖
  • 🔒 类型安全:完全使用 TypeScript 编写,提供完整类型定义
  • 💯 测试全面:每个函数都有完善的单元测试

安装

bash
# npm
npm install @pmun/utils

# yarn
yarn add @pmun/utils

# pnpm
pnpm add @pmun/utils

使用

从主入口导入需要的函数:

typescript
// 导入需要的函数
import { chunk, formatDate, isString, unique } from '@pmun/utils'

// 使用数组工具函数
const arr = [1, 2, 2, 3, 3, 4]
const uniqueArr = unique(arr) // [1, 2, 3, 4]
const chunks = chunk(arr, 2) // [[1, 2], [2, 3], [3, 4]]

// 使用日期格式化
const formattedDate = formatDate(new Date(), 'YYYY-MM-DD') // 例如:'2023-11-10'

// 使用类型检查
console.log(isString('hello')) // true

功能模块

库中包含以下功能模块的工具函数:

  • 数组操作 (array):数组去重、分块、查找、过滤、转换等处理函数
  • 日期时间 (date):日期格式化、计算、比较等函数
  • 字符串处理 (string):字符串转换、格式化、验证等
  • 对象操作 (object):对象深拷贝、合并、转换等
  • 数字处理 (number):数字格式化、四舍五入、范围控制等
  • 类型检查 (is):各种数据类型的判断函数

许可证

MIT