jiezhangxin-utils 0.0.2 → 0.0.4

package/README.md

@@ -1,63 +1,101 @@
 # jiezhangxin-utils
 
-# 捷账芯 智能财务系统工具库
-
-A utility toolkit for Vue 3 projects, providing common functions for date handling, string manipulation, array processing, and storage management.
+A utility toolkit for Vue 3 projects, supporting tree-shaking and按需引入.
 
 ## Installation
-npm install jiezhangxin-utils --save
+
+```bash
+npm install jiezhangxin-utils
+# or
+yarn add jiezhangxin-utils
+# or
+pnpm add jiezhangxin-utils
+```
+
+## Features
+
+- ✅ **按需引入**：支持ES模块tree-shaking
+- ✅ **多种格式**：CJS、ESM、UMD
+- ✅ **Vue 3友好**：兼容Vue 3项目
+- ✅ **类型安全**：良好的类型提示
+
 ## Usage
 
-### In Vue 3 project
-// Import all utilities
-import * as jiezhangxinUtils from 'jiezhangxin-utils';
+### 整体引入
+
+```javascript
+import * as utils from 'jiezhangxin-utils';
+
+// 使用工具函数
+utils.formatMoney(1000);
+utils.handleViewFile('https://example.com/file.pdf');
+```
+
+### 按需引入（推荐）
+
+```javascript
+import { formatMoney, handleViewFile } from 'jiezhangxin-utils';
+
+// 只引入需要的函数
+formatMoney(1000);
+handleViewFile('https://example.com/file.pdf');
+```
+
+### 按需引入具体模块
+
+```javascript
+// 引入工具函数
+import { formatMoney } from 'jiezhangxin-utils';
 
-// Or import specific utilities
-import { formatDate, capitalize } from 'jiezhangxin-utils';
-### Example
-// Format date
-console.log(formatDate(new Date(), 'yyyy-MM-dd HH:mm:ss'));
+// 引入cookie相关函数
+import { getToken, setToken } from 'jiezhangxin-utils';
 
-// Capitalize string
-console.log(capitalize('hello world')); // Output: 'Hello world'
+// 引入常量
+import { CacheKey } from 'jiezhangxin-utils';
+```
 
-// Array deduplication
-console.log(uniqueArray([1, 2, 2, 3, 3, 3])); // Output: [1, 2, 3]
+## API
 
-// Local storage
-setLocalStorage('userInfo', { name: 'John', age: 30 });
-console.log(getLocalStorage('userInfo'));
-## API Documentation
+### 工具函数
 
-### Date Utilities
+- `formatAmountToUnits(amount)` - 将金额格式化为单位数组
+- `getCurrentMonth()` - 获取当前月份
+- `formatMoney(money, decimalPlaces)` - 格式化金额，添加千分位
+- `handleViewFile(fileUrl)` - 安全打开远程文件/PDF
+- `exportFile(exportLoading, exportUrl, name)` - 导出文件
+- `postExportFile(exportLoading, exportUrl, name, params)` - POST方式导出文件
+- `getFileTypeFromUrlRegex(url)` - 从URL获取文件类型
 
-- `formatDate(date, format)`: Format date into string
-- `getDaysBetween(startDate, endDate)`: Get days between two dates
-- `isToday(date)`: Check if date is today
+### Cookie相关
 
-### String Utilities
+- `getToken()` - 获取token
+- `setToken(token)` - 设置token
+- `removeToken()` - 移除token
+- `getUserInfo()` - 获取用户信息
+- `setUserInfo(userInfo)` - 设置用户信息
+- `removeUserInfo()` - 移除用户信息
+- `getCompanyCode()` - 获取公司编码
+- `setCompanyCode(code)` - 设置公司编码
+- `removeCompanyCode()` - 移除公司编码
+- `getCompanyName()` - 获取公司名称
+- `setCompanyName(name)` - 设置公司名称
+- `removeCompanyName()` - 移除公司名称
 
-- `trim(str)`: Remove whitespace from both ends of string
-- `capitalize(str)`: Capitalize the first letter of string
-- `maskStr(str, startLen, endLen, replaceChar)`: Mask string for privacy
-- `isEmail(str)`: Check if string is a valid email
-- `isPhone(str)`: Check if string is a valid phone number
+### 常量
 
-### Array Utilities
+- `CacheKey` - Cookie缓存键名常量
+- `publicKey` - 公钥
+- `version` - 工具库版本
 
-- `uniqueArray(arr)`: Remove duplicates from array
-- `sortArray(arr, key, isAsc)`: Sort array
-- `groupArray(arr, key)`: Group array by key
-- `flattenArray(arr)`: Flatten nested array
+## Build
 
-### Storage Utilities
+```bash
+# 构建生产版本
+npm run build
 
-- `getLocalStorage(key)`: Get item from localStorage
-- `setLocalStorage(key, value)`: Set item to localStorage
-- `removeLocalStorage(key)`: Remove item from localStorage
-- `getSessionStorage(key)`: Get item from sessionStorage
-- `setSessionStorage(key, value)`: Set item to sessionStorage
-- `removeSessionStorage(key)`: Remove item from sessionStorage
+# 开发模式（监听文件变化）
+npm run dev
+```
 
 ## License