master-utils-lib 1.0.2 → 1.2.0

package/jest.config.js

@@ -1,5 +1,4 @@
 module.exports = {
-    preset: 'ts-jest',
     testEnvironment: 'jsdom',
     testMatch: ['**/tests/**/*.test.ts'],
     collectCoverage: true,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "master-utils-lib",
-  "version": "1.0.2",
+  "version": "1.2.0",
   "description": "A professional, lightweight, and compatible utility library for H5 and PC web development with TypeScript support",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",
@@ -56,9 +56,9 @@
     "@rollup/plugin-commonjs": "^29.0.0",
     "@rollup/plugin-node-resolve": "^16.0.3",
     "@rollup/plugin-typescript": "^12.3.0",
-    "@types/jest": "^30.0.0",
-    "jest": "^30.2.0",
-    "jest-environment-jsdom": "^30.2.0",
+    "@types/jest": "^29.5.14",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
     "rimraf": "^6.1.2",
     "rollup": "^4.53.3",
     "ts-jest": "^29.4.5",

package/USAGE_EXAMPLES.md

@@ -1,549 +0,0 @@
-# h5-utils-lib 使用示例
-
-## 📋 库标准评估
-
-### ✅ 符合业界标准
-
-h5-utils-lib 完全符合业界标准，具备以下特性：
-
-1. **多格式支持**
-   - ✅ CommonJS (`main`: `dist/index.js`) - 支持 Node.js 和传统构建工具
-   - ✅ ES Module (`module`: `dist/index.esm.js`) - 支持现代构建工具和 Tree Shaking
-   - ✅ UMD (`dist/index.min.js`) - 支持浏览器直接引入
-   - ✅ TypeScript 类型定义 (`types`: `dist/types/index.d.ts`)
-
-2. **构建配置**
-   - ✅ Rollup 构建，输出多种格式
-   - ✅ Source Map 支持，便于调试
-   - ✅ TypeScript 编译配置完善
-   - ✅ Babel 转译，兼容低版本浏览器
-
-3. **开发体验**
-   - ✅ 完整的 TypeScript 类型支持
-   - ✅ Jest 测试配置
-   - ✅ 代码覆盖率报告
-
-### ✅ 同时支持 TypeScript 和 JavaScript
-
-库完全支持 TypeScript 和 JavaScript 两种使用方式，通过 `package.json` 中的配置自动识别：
-
-- **TypeScript**: 自动识别 `types` 字段，提供完整的类型提示
-- **JavaScript**: 通过 `main` 或 `module` 字段引入，无需额外配置
-
----
-
-## 📦 安装
-
-```bash
-npm install h5-utils-lib
-# 或
-yarn add h5-utils-lib
-# 或
-pnpm add h5-utils-lib
-```
-
----
-
-## 🚀 TypeScript 使用示例
-
-### 1. ES Module 导入（推荐）
-
-```typescript
-// 全部导入
-import * as H5Utils from 'h5-utils-lib';
-
-// 按需导入（支持 Tree Shaking）
-import { 
-  isIOS, 
-  isAndroid, 
-  getQueryString, 
-  setStorage, 
-  formatMoney 
-} from 'h5-utils-lib';
-
-// 使用示例
-if (isIOS()) {
-  console.log('当前设备是 iOS');
-}
-
-const userId = getQueryString('userId'); // 类型推断: string | null
-
-setStorage('userInfo', { name: '张三', age: 25 }, 3600000); // 1小时后过期
-
-const price = formatMoney(1234.56); // 类型推断: string，输出: "¥1,234.56"
-```
-
-### 2. CommonJS 导入
-
-```typescript
-const { isIOS, getQueryString, setStorage } = require('h5-utils-lib');
-
-// TypeScript 中需要类型声明
-declare const require: (module: string) => any;
-```
-
-### 3. Vue 3 + TypeScript 示例
-
-```vue
-<template>
-  <div>
-    <p>设备类型: {{ deviceType }}</p>
-    <p>价格: {{ formattedPrice }}</p>
-  </div>
-</template>
-
-<script setup lang="ts">
-import { ref, onMounted } from 'vue';
-import { isIOS, isAndroid, formatMoney } from 'h5-utils-lib';
-
-const deviceType = ref<string>('');
-const formattedPrice = ref<string>('');
-
-onMounted(() => {
-  if (isIOS()) {
-    deviceType.value = 'iOS';
-  } else if (isAndroid()) {
-    deviceType.value = 'Android';
-  } else {
-    deviceType.value = '其他';
-  }
-  
-  formattedPrice.value = formatMoney(999.99);
-});
-</script>
-```
-
-### 4. React + TypeScript 示例
-
-```tsx
-import React, { useEffect, useState } from 'react';
-import { isIOS, getQueryString, setStorage, getStorage } from 'h5-utils-lib';
-
-interface UserInfo {
-  name: string;
-  age: number;
-}
-
-const App: React.FC = () => {
-  const [device, setDevice] = useState<string>('');
-  const [userId, setUserId] = useState<string | null>(null);
-
-  useEffect(() => {
-    // 设备检测
-    setDevice(isIOS() ? 'iOS' : '其他');
-    
-    // 获取 URL 参数
-    const id = getQueryString('id');
-    setUserId(id);
-    
-    // 存储数据
-    const userInfo: UserInfo = { name: '李四', age: 30 };
-    setStorage('userInfo', userInfo, 7200000); // 2小时过期
-    
-    // 读取数据
-    const stored = getStorage<UserInfo>('userInfo');
-    console.log('存储的用户信息:', stored);
-  }, []);
-
-  return (
-    <div>
-      <p>设备: {device}</p>
-      <p>用户ID: {userId || '未找到'}</p>
-    </div>
-  );
-};
-
-export default App;
-```
-
-### 5. Node.js + TypeScript 示例
-
-```typescript
-import { formatDate, formatMoney, isEmail, isPhone } from 'h5-utils-lib';
-
-// 格式化日期
-const dateStr = formatDate(new Date(), 'YYYY-MM-DD HH:mm:ss');
-console.log(dateStr); // "2024-01-01 12:30:45"
-
-// 格式化金额
-const money = formatMoney(1234567.89, 2, '$');
-console.log(money); // "$1,234,567.89"
-
-// 验证邮箱
-const email = 'test@example.com';
-if (isEmail(email)) {
-  console.log('邮箱格式正确');
-}
-
-// 验证手机号
-const phone = '13800138000';
-if (isPhone(phone)) {
-  console.log('手机号格式正确');
-}
-```
-
----
-
-## 🎯 JavaScript 使用示例
-
-### 1. ES Module 导入（现代浏览器/构建工具）
-
-```javascript
-// 全部导入
-import * as H5Utils from 'h5-utils-lib';
-
-// 按需导入（推荐，支持 Tree Shaking）
-import { 
-  isIOS, 
-  isAndroid, 
-  isWeChat,
-  getQueryString, 
-  stringifyQuery,
-  setStorage, 
-  getStorage,
-  removeStorage,
-  formatMoney,
-  formatDate,
-  isPhone,
-  isEmail
-} from 'h5-utils-lib';
-
-// 使用示例
-if (isIOS()) {
-  console.log('当前设备是 iOS');
-}
-
-if (isWeChat()) {
-  console.log('在微信中打开');
-}
-
-// URL 参数处理
-const userId = getQueryString('userId');
-console.log('用户ID:', userId);
-
-const queryStr = stringifyQuery({ name: '张三', age: 25 });
-console.log('查询字符串:', queryStr); // "name=%E5%BC%A0%E4%B8%89&age=25"
-
-// 存储操作
-setStorage('token', 'abc123', 3600000); // 1小时后过期
-const token = getStorage('token');
-console.log('Token:', token);
-
-// 格式化
-const price = formatMoney(1234.56);
-console.log('价格:', price); // "¥1,234.56"
-
-const date = formatDate(new Date(), 'YYYY-MM-DD HH:mm:ss');
-console.log('日期:', date);
-
-// 验证
-if (isPhone('13800138000')) {
-  console.log('手机号正确');
-}
-
-if (isEmail('test@example.com')) {
-  console.log('邮箱正确');
-}
-```
-
-### 2. CommonJS 导入（Node.js/Webpack）
-
-```javascript
-// 全部导入
-const H5Utils = require('h5-utils-lib');
-
-// 解构导入
-const { 
-  isIOS, 
-  getQueryString, 
-  setStorage, 
-  formatMoney 
-} = require('h5-utils-lib');
-
-// 使用
-if (isIOS()) {
-  console.log('iOS 设备');
-}
-
-const id = getQueryString('id');
-setStorage('data', { key: 'value' });
-const money = formatMoney(999.99);
-```
-
-### 3. Vue 2 + JavaScript 示例
-
-```vue
-<template>
-  <div>
-    <p>设备: {{ device }}</p>
-    <p>价格: {{ price }}</p>
-  </div>
-</template>
-
-<script>
-import { isIOS, isAndroid, formatMoney } from 'h5-utils-lib';
-
-export default {
-  data() {
-    return {
-      device: '',
-      price: ''
-    };
-  },
-  mounted() {
-    if (isIOS()) {
-      this.device = 'iOS';
-    } else if (isAndroid()) {
-      this.device = 'Android';
-    }
-    
-    this.price = formatMoney(1234.56);
-  }
-};
-</script>
-```
-
-### 4. React + JavaScript 示例
-
-```jsx
-import React, { useEffect, useState } from 'react';
-import { isIOS, getQueryString, setStorage, getStorage } from 'h5-utils-lib';
-
-function App() {
-  const [device, setDevice] = useState('');
-  const [userId, setUserId] = useState(null);
-
-  useEffect(() => {
-    setDevice(isIOS() ? 'iOS' : '其他');
-    
-    const id = getQueryString('id');
-    setUserId(id);
-    
-    setStorage('userInfo', { name: '王五', age: 28 }, 3600000);
-    const stored = getStorage('userInfo');
-    console.log('存储的数据:', stored);
-  }, []);
-
-  return (
-    <div>
-      <p>设备: {device}</p>
-      <p>用户ID: {userId || '未找到'}</p>
-    </div>
-  );
-}
-
-export default App;
-```
-
-### 5. 浏览器直接引入（UMD）
-
-```html
-<!DOCTYPE html>
-<html>
-<head>
-  <title>h5-utils-lib 示例</title>
-</head>
-<body>
-  <script src="./node_modules/h5-utils-lib/dist/index.min.js"></script>
-  <script>
-    // 通过全局变量 H5Utils 访问
-    if (H5Utils.isIOS()) {
-      console.log('iOS 设备');
-    }
-    
-    if (H5Utils.isWeChat()) {
-      console.log('微信环境');
-    }
-    
-    const userId = H5Utils.getQueryString('userId');
-    console.log('用户ID:', userId);
-    
-    H5Utils.setStorage('token', 'abc123', 3600000);
-    const token = H5Utils.getStorage('token');
-    console.log('Token:', token);
-    
-    const price = H5Utils.formatMoney(1234.56);
-    console.log('价格:', price);
-    
-    const date = H5Utils.formatDate(new Date(), 'YYYY-MM-DD HH:mm:ss');
-    console.log('日期:', date);
-    
-    if (H5Utils.isPhone('13800138000')) {
-      console.log('手机号正确');
-    }
-  </script>
-</body>
-</html>
-```
-
-### 6. Vite 项目示例
-
-```javascript
-// main.js
-import { createApp } from 'vue';
-import App from './App.vue';
-import { isIOS, formatMoney } from 'h5-utils-lib';
-
-const app = createApp(App);
-
-// 全局使用
-app.config.globalProperties.$utils = {
-  isIOS,
-  formatMoney
-};
-
-app.mount('#app');
-```
-
-### 7. Webpack 项目示例
-
-```javascript
-// webpack.config.js
-module.exports = {
-  // ... 其他配置
-  resolve: {
-    // 自动识别 package.json 中的 main/module/types 字段
-    // 无需额外配置
-  }
-};
-
-// 使用
-import { isIOS, formatMoney } from 'h5-utils-lib';
-```
-
----
-
-## 📚 API 完整列表
-
-### Device（设备检测）
-
-```typescript
-// TypeScript
-import { isIOS, isAndroid, isWeChat } from 'h5-utils-lib';
-
-isIOS(): boolean;        // 检测是否为 iOS 设备
-isAndroid(): boolean;   // 检测是否为 Android 设备
-isWeChat(): boolean;    // 检测是否在微信中打开
-```
-
-```javascript
-// JavaScript
-import { isIOS, isAndroid, isWeChat } from 'h5-utils-lib';
-
-if (isIOS()) { /* ... */ }
-if (isAndroid()) { /* ... */ }
-if (isWeChat()) { /* ... */ }
-```
-
-### URL（URL 处理）
-
-```typescript
-// TypeScript
-import { getQueryString, stringifyQuery } from 'h5-utils-lib';
-
-getQueryString(name: string): string | null;
-stringifyQuery(obj: Record<string, any>): string;
-```
-
-```javascript
-// JavaScript
-import { getQueryString, stringifyQuery } from 'h5-utils-lib';
-
-const id = getQueryString('id');
-const query = stringifyQuery({ name: 'test', age: 20 });
-```
-
-### Storage（本地存储）
-
-```typescript
-// TypeScript
-import { setStorage, getStorage, removeStorage } from 'h5-utils-lib';
-
-setStorage<T>(key: string, value: T, expire?: number | null): void;
-getStorage<T>(key: string): T | null;
-removeStorage(key: string): void;
-```
-
-```javascript
-// JavaScript
-import { setStorage, getStorage, removeStorage } from 'h5-utils-lib';
-
-setStorage('key', 'value', 3600000); // 1小时后过期
-const value = getStorage('key');
-removeStorage('key');
-```
-
-### Format（格式化）
-
-```typescript
-// TypeScript
-import { formatMoney, formatDate } from 'h5-utils-lib';
-
-formatMoney(amount: number | string, decimals?: number, symbol?: string): string;
-formatDate(date: Date | number | string, fmt?: string): string;
-```
-
-```javascript
-// JavaScript
-import { formatMoney, formatDate } from 'h5-utils-lib';
-
-formatMoney(1234.56, 2, '¥'); // "¥1,234.56"
-formatDate(new Date(), 'YYYY-MM-DD HH:mm:ss');
-```
-
-### Validate（验证）
-
-```typescript
-// TypeScript
-import { isPhone, isEmail } from 'h5-utils-lib';
-
-isPhone(phone: string): boolean;
-isEmail(email: string): boolean;
-```
-
-```javascript
-// JavaScript
-import { isPhone, isEmail } from 'h5-utils-lib';
-
-isPhone('13800138000'); // true
-isEmail('test@example.com'); // true
-```
-
----
-
-## 🔍 Tree Shaking 支持
-
-由于库使用 ES Module 导出，支持 Tree Shaking，只会打包使用到的代码：
-
-```javascript
-// ✅ 推荐：按需导入，只打包使用的函数
-import { isIOS, formatMoney } from 'h5-utils-lib';
-
-// ❌ 不推荐：全部导入，会打包所有代码
-import * as H5Utils from 'h5-utils-lib';
-```
-
----
-
-## 📝 注意事项
-
-1. **TypeScript 类型支持**：库提供了完整的类型定义，TypeScript 项目会自动获得类型提示和检查
-2. **浏览器兼容性**：支持 iOS 9+, Android 4.4+, IE11+
-3. **SSR 支持**：所有函数都做了 SSR 兼容处理（检查 `typeof window`）
-4. **存储过期时间**：`setStorage` 的 `expire` 参数单位为毫秒
-
----
-
-## 🎉 总结
-
-h5-utils-lib 是一个**完全符合业界标准**的工具库，具备：
-
-- ✅ 多格式支持（CJS/ESM/UMD）
-- ✅ 完整的 TypeScript 类型定义
-- ✅ 同时支持 TypeScript 和 JavaScript
-- ✅ Tree Shaking 支持
-- ✅ Source Map 支持
-- ✅ 完善的构建配置
-
-无论是 TypeScript 还是 JavaScript 项目，都可以无缝使用！
-