@pmun/utils 0.2.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 sunpm
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE. 

package/README.md

@@ -0,0 +1,86 @@
+# sunpm-utils
+
+[![npm version](https://img.shields.io/npm/v/sunpm-utils.svg)](https://www.npmjs.com/package/sunpm-utils)
+[![license](https://img.shields.io/npm/l/sunpm-utils.svg)](https://github.com/sunpm/sunpm-utils/blob/main/LICENSE)
+
+一个轻量级、模块化的 TypeScript 工具函数库，为日常开发提供便捷实用的工具集合。
+
+## 特点
+
+- 🚀 **轻量级**：按需引入，不增加项目体积
+- 🧩 **模块化**：合理划分模块，易于使用和维护
+- 📦 **零依赖**：除日期处理外无外部依赖
+- 🔒 **类型安全**：完全使用 TypeScript 编写，提供完整类型定义
+- 💯 **测试全面**：每个函数都有完善的单元测试
+
+## 安装
+
+```bash
+# npm
+npm install sunpm-utils
+
+# yarn
+yarn add sunpm-utils
+
+# pnpm
+pnpm add sunpm-utils
+```
+
+## 使用
+
+从主入口导入需要的函数：
+
+```typescript
+// 导入需要的函数
+import { chunk, formatDate, isString, unique } from 'sunpm-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)**：各种数据类型的判断函数
+
+## 文档
+
+本项目使用 TypeDoc 自动生成文档，可通过以下方式查看：
+
+1. **在线文档**：访问 [https://sunpm.github.io/sunpm-utils/](https://sunpm.github.io/sunpm-utils/)（需要部署后访问）
+
+2. **本地查看**：
+
+   ```bash
+   # 生成文档
+   pnpm docs
+
+   # 在浏览器中打开
+   open docs/index.html
+   ```
+
+3. **部署文档**：
+   ```bash
+   # 生成并部署到 GitHub Pages
+   pnpm docs:deploy
+   ```
+
+详细的 API 文档中包含每个函数的说明、参数、返回值和使用示例。
+
+## 许可证
+
+[MIT](LICENSE)