zhl-easy 0.0.1 → 0.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 zhl-easy
+
+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

@@ -1,3 +1,57 @@
-# zhl-easy
-
-JS 工具类
+# zhl-easy
+
+JS 工具类以及 `vue` `react` 组件。
+
+## 安装
+
+```bash
+npm install zhl-easy
+```
+
+## 使用
+
+```ts
+import { isPhone, toUrlQuery } from "zhl-easy";
+// 或者只引入工具函数
+import { debounce } from "zhl-easy/utils";
+
+isPhone("15093676561"); // true
+toUrlQuery({ a: 1 }); // '?a=1'
+```
+
+## 工具函数
+
+| 方法 | 说明 |
+| --- | --- |
+| `tel` | 手机号正则 |
+| `idCard` | 身份证号正则 |
+| `isPhone(value)` | 手机号校验 |
+| `isIDCode(value)` | 身份证号校验 |
+| `toUrlQuery(query)` | 对象转 url 参数 |
+| `urlQueryToObject(str)` | url 参数转对象 |
+| `numberToPrice(number)` | 数字转千位符 |
+| `priceToNumber(data)` | 千位符转数字 |
+| `setTwoDecimal(number, isAdjust)` | 保留两位小数 |
+| `getRandomNumber(min, max)` | 生成区间内随机数 |
+| `isType(data, type?)` | 检测数据类型 |
+| `toInt(value)` | 转换成整数 |
+| `copyText(content)` | 复制文本（浏览器环境） |
+| `downloadFile(url, name)` | 下载文件（浏览器环境） |
+| `debounce(fn, wait)` | 防抖 |
+| `throttle(fn, threshhold, scope?)` | 节流 |
+
+## 开发
+
+```bash
+npm install      # 安装依赖
+npm run build    # 编译到 dist/
+```
+
+## 发布
+
+```bash
+npm login
+npm publish
+```
+
+发布前会自动执行 `npm run build`（见 `prepublishOnly`）。

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from "./utils/index.js";

package/dist/index.js

@@ -0,0 +1,2 @@
+// 工具函数
+export * from "./utils/index.js";

package/dist/utils/index.d.ts

@@ -0,0 +1,99 @@
+export declare const tel: RegExp;
+export declare const idCard: RegExp;
+/**
+ * 手机号校验
+ * @example isPhone('15093676561') => true
+ * @param value 要校验的数据
+ * @returns true false 是 否
+ */
+export declare const isPhone: (value: number | string) => boolean;
+/**
+ * 身份证号校验
+ * @example isIDCode('410781199909090000') => true
+ * @param value 要校验的数据
+ * @returns true false 是 否
+ */
+export declare const isIDCode: (value: number | string) => boolean;
+/**
+ * 对象转url参数
+ * @example toUrlQuery({a:1}) => '?a=1'
+ * @param query 要转换的对象
+ */
+export declare const toUrlQuery: (query: Record<string, unknown>) => string;
+/**
+ * url参数转对象
+ * @example urlQueryToObject('?a=1') => {a:1}
+ * @param str 要转换的url参数
+ */
+export declare const urlQueryToObject: (str: string) => Record<string, string>;
+/**
+ * 将传入的数据转换成千位符
+ * @example numberToPrice(1234.12) => '1,234.12'
+ * @param number 要转换的数字
+ */
+export declare const numberToPrice: (number: number | string) => string;
+/**
+ * 千位符格式转换数字
+ * @example moneyToNumber('123,456.789') => 123456.789
+ * @param data 要转换的数据
+ */
+export declare const priceToNumber: (data: string) => number;
+/**
+ * 保留两位小数
+ * @example setTwoDecimal(3.144) => '3.14'
+ * @param number 要保留两位小数的数字
+ * @param isAdjust 是否四舍五入
+ */
+export declare const setTwoDecimal: (number: number | string, isAdjust: boolean) => string | number;
+/**
+ * 生成随机数
+ * @example getRandomNumber(1,100) => 98
+ * @param min 最小值
+ * @param max 最大值
+ */
+export declare const getRandomNumber: (min: number, max: number) => number;
+/**
+ * 检测数据格式
+ * @example isType({},Object) => true
+ * @example isType({}) => Object
+ * @param data 要检测的数据
+ * @param type 类型  非必填
+ * @returns 不传type 返回数据的类型   传type   返回 true false
+ */
+export declare const isType: (data: unknown, type?: string) => boolean | string;
+/**
+ * 转换成整数
+ * @example toInt(123.123) => 123
+ * @param value 要转成整数的数据
+ * @returns true false 是 否
+ */
+export declare const toInt: (value: number | string) => number;
+/**
+ * 复制
+ * @example copyText(123) => Promise
+ * @param content 要复制的数据
+ * @returns Promise true false  复制成功  失败
+ */
+export declare const copyText: (content: any) => Promise<boolean>;
+/**
+ * 下载文件
+ * @example downloadFile('www.baidu.com','文件名称')
+ * @param url 要下载的文件 地址
+ * @param name 要下载的文件名称
+ */
+export declare const downloadFile: (url: string, name: string) => void;
+/**
+ * 防抖
+ * @example debounce(() => {}, 250) => Function
+ * @param fn 防抖的函数
+ * @param wait 防抖时间 毫秒
+ */
+export declare const debounce: (fn: (...args: unknown[]) => void, wait?: number) => (this: unknown, ...args: unknown[]) => void;
+/**
+ * 节流
+ * @example throttle(()=>{}) => Function
+ * @param fn 节流的函数
+ * @param threshhold 节流时间
+ * @param scope this
+ */
+export declare const throttle: (fn: (...args: unknown[]) => void, threshhold?: number, scope?: unknown) => (this: unknown, ...args: unknown[]) => void;

package/dist/utils/index.js

@@ -0,0 +1,221 @@
+// 手机号
+export const tel = /^1[3456789]\d{9}$/;
+// 身份证
+export const idCard = /^[1-9]\d{5}[1-9]\d{3}((0\d)|(1[0-2]))(([0|1|2]\d)|3[0-1])\d{3}([0-9]|X)$/;
+/**
+ * 手机号校验
+ * @example isPhone('15093676561') => true
+ * @param value 要校验的数据
+ * @returns true false 是 否
+ */
+export const isPhone = (value) => {
+    if (typeof value == "number") {
+        value = String(value);
+    }
+    return tel.test(value);
+};
+/**
+ * 身份证号校验
+ * @example isIDCode('410781199909090000') => true
+ * @param value 要校验的数据
+ * @returns true false 是 否
+ */
+export const isIDCode = (value) => {
+    if (typeof value == "string") {
+        return idCard.test(value);
+    }
+    return false;
+};
+/**
+ * 对象转url参数
+ * @example toUrlQuery({a:1}) => '?a=1'
+ * @param query 要转换的对象
+ */
+export const toUrlQuery = (query) => {
+    let str = "?";
+    Object.keys(query).forEach((key) => {
+        str += `${key}=${query[key] ? String(query[key]) : ""}&`;
+    });
+    return str.slice(0, -1);
+};
+/**
+ * url参数转对象
+ * @example urlQueryToObject('?a=1') => {a:1}
+ * @param str 要转换的url参数
+ */
+export const urlQueryToObject = (str) => {
+    const params = new URLSearchParams(str);
+    const obj = {};
+    params.forEach((item, index) => {
+        obj[index] = item;
+    });
+    return obj;
+};
+/**
+ * 将传入的数据转换成千位符
+ * @example numberToPrice(1234.12) => '1,234.12'
+ * @param number 要转换的数字
+ */
+export const numberToPrice = (number) => {
+    return Number(number).toLocaleString("zh", {
+        minimumFractionDigits: 2,
+        maximumFractionDigits: 2,
+        style: "decimal",
+    });
+};
+/**
+ * 千位符格式转换数字
+ * @example moneyToNumber('123,456.789') => 123456.789
+ * @param data 要转换的数据
+ */
+export const priceToNumber = (data) => {
+    return Number(data.replace(/,/gi, ""));
+};
+/**
+ * 保留两位小数
+ * @example setTwoDecimal(3.144) => '3.14'
+ * @param number 要保留两位小数的数字
+ * @param isAdjust 是否四舍五入
+ */
+export const setTwoDecimal = (number, isAdjust) => {
+    if (isAdjust) {
+        return Math.round(Number(number) * Math.pow(10, 2)) / Math.pow(10, 2);
+    }
+    return (Math.floor(Number(number) * 100) / 100).toFixed(2);
+};
+/**
+ * 生成随机数
+ * @example getRandomNumber(1,100) => 98
+ * @param min 最小值
+ * @param max 最大值
+ */
+export const getRandomNumber = (min, max) => {
+    return Math.floor(Math.random() * (max - min + 1)) + min;
+};
+/**
+ * 检测数据格式
+ * @example isType({},Object) => true
+ * @example isType({}) => Object
+ * @param data 要检测的数据
+ * @param type 类型  非必填
+ * @returns 不传type 返回数据的类型   传type   返回 true false
+ */
+export const isType = (data, type) => {
+    const regex = /\[object (\w+)\]/;
+    const str = Object.prototype.toString.call(data);
+    const match = regex.exec(str);
+    if (!match)
+        return "";
+    return type ? match[1] === type : match[1];
+};
+/**
+ * 转换成整数
+ * @example toInt(123.123) => 123
+ * @param value 要转成整数的数据
+ * @returns true false 是 否
+ */
+export const toInt = (value) => {
+    if (typeof value == "number") {
+        return ~~value;
+    }
+    if (typeof value == "string") {
+        return parseInt(value, 10);
+    }
+    return 0;
+};
+/**
+ * 复制
+ * @example copyText(123) => Promise
+ * @param content 要复制的数据
+ * @returns Promise true false  复制成功  失败
+ */
+export const copyText = (content) => {
+    return new Promise((resolve, reject) => {
+        try {
+            // 创建输入框元素
+            const input = document.createElement("input"); //不会保留文本格式
+            //如果要保留文本格式，比如保留换行符，或者多行文本，可以使用  textarea 标签，再配和模板字符串 ` `
+            //const input = document.createElement('textarea')
+            // 将想要复制的值
+            input.value = content;
+            // 页面底部追加输入框
+            document.body.appendChild(input);
+            // 选中输入框
+            input.select();
+            // 执行浏览器复制命令
+            document.execCommand("Copy");
+            // 弹出复制成功信息
+            //this.$message.success('复制成功');
+            // 复制后移除输入框
+            input.remove();
+            resolve(true);
+        }
+        catch (err) {
+            reject(false);
+            console.log("复制失败", err);
+        }
+    });
+};
+/**
+ * 下载文件
+ * @example downloadFile('www.baidu.com','文件名称')
+ * @param url 要下载的文件 地址
+ * @param name 要下载的文件名称
+ */
+export const downloadFile = (url, name) => {
+    let a = document.createElement("a");
+    a.href = url;
+    a.download = name;
+    a.target = "_blank";
+    a.style.display = "none";
+    document.body.appendChild(a);
+    a.click();
+    a.remove();
+};
+/**
+ * 防抖
+ * @example debounce(() => {}, 250) => Function
+ * @param fn 防抖的函数
+ * @param wait 防抖时间 毫秒
+ */
+export const debounce = (fn, wait = 250) => {
+    let timeout = null;
+    return function (...args) {
+        if (timeout)
+            clearTimeout(timeout);
+        let callNow = !timeout;
+        timeout = setTimeout(() => {
+            timeout = null;
+        }, wait);
+        if (callNow)
+            fn.apply(this, args);
+    };
+};
+/**
+ * 节流
+ * @example throttle(()=>{}) => Function
+ * @param fn 节流的函数
+ * @param threshhold 节流时间
+ * @param scope this
+ */
+export const throttle = (fn, threshhold = 250, scope) => {
+    let last = null;
+    let timer = null;
+    return function (...args) {
+        let context = scope || this;
+        let now = +new Date();
+        if (last !== null && now < last + threshhold) {
+            // 如果在节流时间内，则取消之前的延迟调用
+            clearTimeout(timer);
+            // 设定一个新的延迟调用
+            timer = setTimeout(function () {
+                last = now;
+                fn.apply(context, args);
+            }, threshhold);
+        }
+        else {
+            last = now;
+            fn.apply(context, args);
+        }
+    };
+};

package/package.json

@@ -1,4 +1,48 @@
-{
-  "name": "zhl-easy",
-  "version": "0.0.1"
-}
+{
+  "name": "zhl-easy",
+  "version": "0.0.2",
+  "description": "JS 工具函数库，以及 Vue / React 组件",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./utils": {
+      "types": "./dist/utils/index.d.ts",
+      "import": "./dist/utils/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "VERSION.md"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "zhl-easy",
+    "utils",
+    "tools",
+    "typescript"
+  ],
+  "license": "MIT",
+  "devDependencies": {
+    "typescript": "^5.9.3"
+  },
+  "repository": {
+    "type": "gitee",
+    "url": "git+https://github.com/你的用户名/zhl-easy.git"
+  },
+  "author": {
+    "name": "zhl",
+    "email": "tuochu@qq.com"
+  }
+}

package/VERSION.md

@@ -1,10 +0,0 @@
-# zhl-easy
-
-### npm 命令
-
-npm login 登录
-npm publish 发布
-
-# 版本更新日志
-
-### 0.0.1

package/index.ts

@@ -1 +0,0 @@
-console.log('1')