lyb-js 1.0.2 → 1.0.4

package/README.md

@@ -1,5 +1,11 @@
 # Lib自用JS工具方法
 
+## 介绍
+
+> 该库为作者在写项目时收集的常用方法，代码简陋，没有严格的边缘处理
+>
+> 鼠标悬浮在每一个方法上都有较为完整的`Jsdoc`提示
+
 ## 起步
 
 > 完整使用
@@ -7,28 +13,520 @@
 ```ts
 import { Lib } from "lib-js-utils";
 
-Lib.Base.libGetDataType("Hellow World!");
+Lib.Base.libGetDataType("Hellow World!"); //"string"
+```
+
+> 按需引入，打包时就不会把整个库打进去
+
+```ts
+import { libGetDataType } from "lyb-js/dist/Base/LibGetDataType";
+
+libGetDataType("Hellow World!"); //"string"
 ```
 
-> 按需引入
+> 如果在多个文件使用到同一个方法，建议采用按需引入聚合导出
 
 ```ts
-import { libGetDataType } from "lib-js-utils/dist/libGetDataType";
+//你的公共工具函数文件 utils.ts
+export * from "lyb-js/dist/Base/LibGetDataType";
+export * from "lyb-js/dist/Math/LibCalculateExpression";
+
+//你的项目文件 index.ts
+import { libGetDataType,libCalculateExpression } from "utils";
 
-libGetDataType("Hellow World!");
+libGetDataType("Hellow World!"); //"string"
+libCalculateExpression("(1+2)-(3*4)/5"); //0.6
 ```
 
-> 按需使用
+## 目录
+
+### 基础
+
+\- [LibGetDataType-数据类型](###LibGetDataType-数据类型)
+
+\- [LibPromiseTimeout-延时执行](###LibPromiseTimeout-延时执行)
+
+
+## Browser-浏览器
+
+\- [LibColorConsole-有色打印](###LibColorConsole-有色打印)
+
+\- [LibIsMobile-判断手机](###LibIsMobile-判断手机)
+
+\- [LibIsPad-判断平板](###LibIsPad-判断平板)
+
+\- [LibPathParams-地址栏参数](###LibPathParams-地址栏参数)
+
+\- [LibSetTitleIcon-网站标题图标](###LibSetTitleIcon-网站标题图标)
+
+\- [LibTagTitleTip-网站标题交互](###LibTagTitleTip-网站标题交互)
+
+
+## Data-数据
+
+\- [LibChunkArray-数组拆分](###LibChunkArray-数组拆分)
+
+\- [LibDeepJSONParse-深度解析JSON](###LibDeepJSONParse-深度解析JSON)
+
+\- [LibGroupArrayByKey-分类汇总](###LibGroupArrayByKey-分类汇总)
+
+\- [LibMatchEmail-匹配E-Mail](###LibMatchEmail-匹配E-Mail)
+
+\- [LibShuffleArray-数组乱序](###LibShuffleArray-数组乱序)
+
+\- [LibStepArray-数组偏移](###LibStepArray-数组偏移)
+
+
+## File-文件
+
+\- [LibDownloadImageLink-图片下载](###LibDownloadImageLink-图片下载)
+
+\- [LibImageOptimizer-图片压缩](###LibImageOptimizer-图片压缩)
+
+\- [LibSaveJson-保存文件](###LibSaveJson-保存文件)
+
+
+## Formatter-格式化
+
+\- [LibFormatterByte-字节格式化](###LibFormatterByte-字节格式化)
+
+\- [LibMaskPhoneNumber-隐藏手机号码](###LibMaskPhoneNumber-隐藏手机号码)
+
+\- [LibNumberUnit-数字单位](###LibNumberUnit-数字单位)
+
+\- [LibNumComma-数字逗号](###LibNumComma-数字逗号)
+
+\- [LibSecondsFormatterChinese-中文时间](###LibSecondsFormatterChinese-中文时间)
+
+
+## Math-数学
+
+\- [LibCalculateExpression-表达式字符串](###LibCalculateExpression-表达式字符串)
+
+\- [LibConvertAngle-角弧度互转](###LibConvertAngle-角弧度互转)
+
+\- [LibCoordsAngle-两点角度](###LibCoordsAngle-两点角度)
+
+\- [LibCoordsDistance-两点距离](###LibCoordsDistance-两点距离)
+
+\- [LibDecimal-高精度计算](###LibDecimal-高精度计算)
+
+
+## Misc-杂项
+
+\- [LibRegFormValidate-表单验证](###LibRegFormValidate-表单验证)
+
+\- [LibRetryRequest-请求重连](###LibRetryRequest-请求重连)
+
+
+## Random-随机
+
+\- [LibProbabilityResult-概率触发](###LibProbabilityResult-概率触发)
+
+\- [LibRandom-随机数](###LibRandom-随机数)
+
+\- [LibRandomColor-随机色](###LibRandomColor-随机色)
+
+\- [LibUniqueRandomNumbers-随机数数组](###LibUniqueRandomNumbers-随机数数组)
+
+
+## Time-时间
+
+\- [LibSameTimeCheck-时间比对](###LibSameTimeCheck-时间比对)
+
+\- [LibTimeAgo-中文时间差](###LibTimeAgo-中文时间差)
+
+\- [LibTimeGreeting-时间问候](###LibTimeGreeting-时间问候)
+
 
 ## Base-基础
 
-### LibGetDataType
+### LibGetDataType-数据类型
 
 > 返回数据类型
 
 ```ts
-libGetDataType(123); // "number"
-libGetDataType("hello"); // "string"
-libGetDataType([1, 2, 3]); // "array"
+libGetDataType(123); //"number"
+libGetDataType("hello"); //"string"
+libGetDataType([1, 2, 3]); //"array"
+```
+
+### LibPromiseTimeout-延时执行
+
+> 延时执行，切换到其他页面会暂停
+
+```ts
+libPromiseTimeout(3000, () => {
+  console.log("执行延时函数");
+});
+```
+
+## Browser-浏览器
+
+### LibColorConsole-有色打印
+
+> `console`有色打印
+
+```ts
+//使用红色打印日志
+libColorConsole("错误提示", "red", [{ label: "错误代码", value: 500 }]);
+
+//使用蓝色打印简单日志
+libColorConsole("信息", "blue", "操作成功");
+```
+
+### LibIsMobile-判断手机
+
+> 判断是否为移动设备
+
+```ts
+const isMobile = libIsMobile();
+console.log(isMobile); //true 或 false
+```
+
+### LibIsPad-判断平板
+
+> 判断是否为平板
+
+```ts
+const isPad = libIsPad();
+console.log(isPad); //true 或 false
+```
+
+### LibPathParams-地址栏参数
+
+> 获取浏览器地址栏参数
+
+```ts
+const params = libPathParams();
+console.log(params); //{ param1: "value1", param2: "value2" }
+```
+
+### LibSetTitleIcon-网站标题图标
+
+> 动态设置网站标题及图标，涉及到不同平台的打包，可以根据不同环境来设置网站标题和图标
+
+```ts
+libSetTitleIcon("我的网站", "https://example.com/favicon.ico");
+```
+
+### LibTagTitleTip-网站标题交互
+
+> 网站标题交互，当从当前网页切换到其他网页，网站标题自动切换
+
+```ts
+libTagTitleTip("欢迎回来", "来和妲己玩耍吧！");
+```
+
+## Data-数据
+
+### LibChunkArray-数组拆分
+
+> 将数组拆分成指定数组元素数量的多个数组
+
+```ts
+const chunks = libChunkArray([1, 2, 3, 4, 5, 6], 2);
+console.log(chunks); //[[1, 2], [3, 4], [5, 6]]
+```
+
+### LibDeepJSONParse-深度解析JSON
+
+> 递归将JSON字符串深度解析为对象
+
+```ts
+const obj = libDeepJSONParse('{"a": 1, "b": "{\"c\": 2}"}');
+console.log(obj); //{ a: 1, b: { c: 2 } }
+```
+
+### LibGroupArrayByKey-分类汇总
+
+> 将数组对象按照指定键值整理成一个以键值为键名的对象
+
+```ts
+const grouped = libGroupArrayByKey([{ id: 1, name: 'A' }, { id: 2, name: 'B' }, { id: 1, name: 'C' }], 'id');
+console.log(grouped); //{ 1: [{ id: 1, name: 'A' }, { id: 1, name: 'C' }], 2: [{ id: 2, name: 'B' }] }
+```
+
+### LibMatchEmail-匹配E-Mail
+
+> 可用于实时输入时，自动补全常用邮箱后缀
+
+```ts
+const emails = libMatchEmail("user", ["@gmail.com", "@yahoo.com"]);
+console.log(emails); //["user@gmail.com", "user@yahoo.com"]
+```
+
+### LibShuffleArray-数组乱序
+
+> 将数组打乱顺序
+
+```ts
+const shuffled = libShuffleArray([1, 2, 3, 4, 5]);
+console.log(shuffled); //[3, 5, 2, 1, 4] （结果每次不同）
+```
+
+### LibStepArray-数组偏移
+
+> 数组元素整体步数移动
+
+```ts
+const moved = libStepArray([1, 2, 3, 4, 5], 2);
+console.log(moved); //[4, 5, 1, 2, 3]
+```
+
+## File-文件
+
+### LibDownloadImageLink-图片下载
+
+> 将链接图片下载到本地
+
+```ts
+libDownloadImageLink("https://example.com/image.jpg", "图片.jpg");
+```
+
+### LibImageOptimizer-图片压缩
+
+> 支持`png`压缩，保留透明背景
+
+```ts
+//图片压缩使用示例
+libImageOptimizerOptionsParams({
+  file: myFile,
+  ratio: 0.8,
+  width: 800,
+  maxSize: 1024,
+  success: (formData, file, url) => {
+    console.log('压缩成功', formData, file, url);
+  },
+  fail: (error) => {
+    console.error('压缩失败', error);
+  }
+});
+```
+
+### LibSaveJson-保存文件
+
+> 保存`JSON`文件到本地，也支持保存纯文本的`txt`文件
+
+```ts
+libSaveJson(JSON.stringify({ key: "value" }), "example.json");、
+libSaveJson("Hellow World!", "example.txt");
+```
+
+## Formatter-格式化
+
+### LibFormatterByte-字节格式化
+
+> 将字节单位的数字格式化
+
+```ts
+const [size, unit, formatted] = libFormatterByte(2048);
+console.log(size, unit, formatted); //2.00 KB 2.00 KB
+```
+
+### LibMaskPhoneNumber-隐藏手机号码
+
+> 隐藏手机号码中间的四位数字
+
+```ts
+const masked = libMaskPhoneNumber("13812345678");
+console.log(masked); //138****5678
+```
+
+### LibNumberUnit-数字单位
+
+> 大于指定数字，用单位标识，你甚至可以用中文
+
+```ts
+const [value, unit] = libNumberUnit(1500, { K: 1000, M: 1000000 });
+console.log(value, unit); //1.50 K
+
+const [value, unit] = libNumberUnit(0.05, { 分: 0.01, 角: 0.1, 元: 1 });
+console.log(value, unit); //0.05 分
+```
+
+### LibNumComma-数字逗号
+
+> 数字每三位添加逗号
+
+```ts
+const formatted = libNumComma(1234567.89);
+console.log(formatted); //1,234,567.89
+```
+
+### LibSecondsFormatterChinese-中文时间
+
+> 将秒数格式化为中文时间描述，支持扩展到年
+
+```ts
+libSecondsFormatterChinese(100000); //"1天3小时46分40秒"
+libSecondsFormatterChinese(31536000); //"1年"
+libSecondsFormatterChinese(3600); //"1小时"
+libSecondsFormatterChinese(90); //"1分30秒"
+```
+
+## Math-数学
+
+### LibCalculateExpression-表达式字符串
+
+> 计算表达式字符串
+
+```ts
+const result = libCalculateExpression("(1+2)-(3*4)/5");
+console.log(result); //0.6
+```
+
+### LibConvertAngle-角弧度互转
+
+> 角度和弧度互相转换
+
+```ts
+//角度转弧度
+libConvertAngle(90, "rad"); //返回 1.5708... (π/2)
+
+//弧度转角度
+libConvertAngle(Math.PI, "deg"); //返回 180
+```
+
+### LibCoordsAngle-两点角度
+
+> 计算两点角度
+
+```ts
+libCoordsAngle({ x: 0, y: 0 }, { x: 1, y: 0 }); //0
+libCoordsAngle({ x: 0, y: 0 }, { x: 1, y: 1 }); //45
+libCoordsAngle({ x: 0, y: 0 }, { x: 0, y: 1 }); //90
+```
+
+### LibCoordsDistance-两点距离
+
+> 计算两点距离
+
+```ts
+libCoordsDistance({ x: 0, y: 0 }, { x: 3, y: 4 }); //5
+libCoordsDistance({ x: 1, y: 1 }, { x: 4, y: 5 }); //5
+libCoordsDistance({ x: 0, y: 0 }, { x: 0, y: 0 }); //0
+```
+
+### LibDecimal-高精度计算
+
+> 计算两个数的运算结果，并保留指定位数的小数
+
+```ts
+libDecimal(10, 3, "+"); //13
+libDecimal(10, 3, "-"); //7
+libDecimal(10, 3, "/", 2); //3.33
+```
+
+## Misc
+
+### LibRegFormValidate-表单验证
+
+> 通过传递对象数字的方式进行正则或自定义函数进行验证
+
+```ts
+const form = { username: "john", email: "john@example.com" };
+const rules = [
+  { key: "username", verify: /^[a-zA-Z0-9]{3,}$/, msg: "用户名不合法", name: "用户名" },
+  { key: "email", verify: /^\S+@\S+\.\S+$/, msg: "邮箱格式不正确", name: "邮箱" },
+];
+libRegFormValidate(form, rules);
+//返回结果: []
+
+const invalidForm = { username: "jo", email: "invalid-email" };
+libRegFormValidate(invalidForm, rules);
+//返回结果: [
+//  { key: "username", msg: "用户名不合法", name: "用户名" },
+//  { key: "email", msg: "邮箱格式不正确", name: "邮箱" }
+//]
+```
+
+### LibRetryRequest-请求重连
+
+> 请求失败重连
+
+```ts
+const requestFn = (params: { url: string }) => fetch(params.url).then(res => res.json());
+const params = { url: "https://api.example.com/data" };
+libRetryRequest({
+  promiseFn: requestFn,
+  params,
+  maxRetries: 5,
+  retryDelay: 1000
+})
+.then(data => console.log(data))
+.catch(err => console.error(err));
+```
+
+## Random-随机
+
+### LibProbabilityResult-概率触发
+
+> 百分比概率结果
+
+```ts
+libProbabilityResult(50); //50% 概率为 true
+libProbabilityResult(80); //80% 概率为 true
+libProbabilityResult(100); //100% 概率为 true
+```
+
+### LibRandom-随机数
+
+> 随机获取两个数之间的值，包含两数自身
+
+```ts
+libRandom(1, 10); //1 到 10 之间的随机整数
+libRandom(1, 10, 2); //1 到 10 之间保留两位小数的随机数
+```
+
+### LibRandomColor-随机色
+
+> 随机 RGBA 颜色
+
+```ts
+libRandomColor(); //生成随机的 RGBA 颜色，默认透明度 1
+libRandomColor(0.5); //生成随机的 RGBA 颜色，透明度为 0.5
+```
+
+### LibUniqueRandomNumbers-随机数数组
+
+> 随机生成指定个数、指定范围不重复的随机数数组
+
+```ts
+libUniqueRandomNumbers(1, 10, 5); //从 1 到 10 中随机生成 5 个唯一数字
+libUniqueRandomNumbers(1, 100, 10); //从 1 到 100 中随机生成 10 个唯一数字
+```
+
+## Time-时间
+
+### LibSameTimeCheck-时间比对
+
+> 传入时间戳与当前时间判断是否为同一分、同一时、同一天、同一周、同一月、同一年
+
+```ts
+const timestamp = 1679872800000; //时间戳
+const result = libSameTimeCheck(timestamp, 'day'); //判断是否为同一天
+console.log(result); //0: 同一天, 1: 新的一天, -1: 时间戳大于当前时间
+```
+
+### LibTimeAgo-中文时间差
+
+> 时间差计算
+
+```ts
+libTimeAgotamp(Date.now() - 3600000); //"1 小时前"
+libTimeAgotamp(Date.now() - 86400000); //"1 天前"
+libTimeAgotamp(Date.now() - 31536000000); //"1 年前"
+libTimeAgotamp(Date.now() - 10000); //"刚刚"
+```
+
+### LibTimeGreeting-时间问候
+
+> 根据当前时间返回问候语
+
+```ts
+libTimeGreeting(); //根据当前时间返回默认问候语
+libTimeGreeting({ morning: "早安" }); //自定义早上问候语
+libTimeGreeting({ afternoon: "午后好" }); //自定义下午问候语
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lyb-js",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "author": "冷弋白",
   "description": "lyb自用JS方法库",
   "repository": {

package/dist/Base/LibGetDataType/index.d.ts

@@ -1,10 +0,0 @@
-export type LibGetDataTypeReturnType = "string" | "number" | "boolean" | "array" | "function" | "object";
-/**
- * @description 返回数据类型
- * @param v 需要判断类型的数据
- * @example
- * libGetDataType(123); // "number"
- * libGetDataType("hello"); // "string"
- * libGetDataType([1, 2, 3]); // "array"
- */
-export declare const libGetDataType: (v: any) => LibGetDataTypeReturnType;

package/dist/Base/LibGetDataType/index.js

@@ -1,15 +0,0 @@
-/**
- * @description 返回数据类型
- * @param v 需要判断类型的数据
- * @example
- * libGetDataType(123); // "number"
- * libGetDataType("hello"); // "string"
- * libGetDataType([1, 2, 3]); // "array"
- */
-export const libGetDataType = (v) => {
-    return Object.prototype.toString
-        .call(v)
-        .substring(8)
-        .replace(/]/g, "")
-        .toLowerCase();
-};

package/dist/Base/LibJsGetDataType/index.d.ts

@@ -1,7 +0,0 @@
-type ReturnType = "string" | "number" | "boolean" | "array" | "function" | "object";
-/**
- * @description 返回数据类型
- * @param v 需要判断类型的数据
- */
-export declare const libJsGetDataType: (v: any) => ReturnType;
-export {};

package/dist/Base/LibJsGetDataType/index.js

@@ -1,11 +0,0 @@
-/**
- * @description 返回数据类型
- * @param v 需要判断类型的数据
- */
-export const libJsGetDataType = (v) => {
-    return Object.prototype.toString
-        .call(v)
-        .substring(8)
-        .replace(/]/g, "")
-        .toLowerCase();
-};

package/dist/Base/LibPromiseTimeout/index.d.ts

@@ -1,10 +0,0 @@
-/**
- * @description 延时执行，切换到其他页面会暂停
- * @param delay 延时毫秒数
- * @param fn 延时执行函数
- * @example
- * libPromiseTimeout(3000, () => {
- *   console.log("执行延时函数");
- * });
- */
-export declare const libPromiseTimeout: (delay?: number, fn?: () => void) => Promise<void>;

package/dist/Base/LibPromiseTimeout/index.js

@@ -1,40 +0,0 @@
-/**
- * @description 延时执行，切换到其他页面会暂停
- * @param delay 延时毫秒数
- * @param fn 延时执行函数
- * @example
- * libPromiseTimeout(3000, () => {
- *   console.log("执行延时函数");
- * });
- */
-export const libPromiseTimeout = (delay = 1, fn) => {
-    let timeoutId;
-    let remainingTime = delay;
-    let startTime = Date.now();
-    let isPaused = false;
-    return new Promise((resolve) => {
-        const handleVisibilityChange = () => {
-            if (document.hidden) {
-                isPaused = true;
-                clearTimeout(timeoutId);
-                remainingTime -= Date.now() - startTime;
-            }
-            else {
-                if (isPaused) {
-                    isPaused = false;
-                    startTime = Date.now();
-                    startTimeout(resolve);
-                }
-            }
-        };
-        const startTimeout = (resolve) => {
-            timeoutId = setTimeout(() => {
-                fn?.();
-                resolve();
-                document.removeEventListener("visibilitychange", handleVisibilityChange);
-            }, remainingTime);
-        };
-        document.addEventListener("visibilitychange", handleVisibilityChange);
-        startTimeout(resolve);
-    });
-};

package/dist/Browser/LibColorConsole/index.d.ts

@@ -1,15 +0,0 @@
-/** @description console颜色打印
- * @param title 标题
- * @param color 颜色
- * @param logs 信息
- * @example
- * // 使用红色打印日志
- * libColorConsole("错误提示", "red", [{ label: "错误代码", value: 500 }]);
- *
- * // 使用蓝色打印简单日志
- * libColorConsole("信息", "blue", "操作成功");
- */
-export declare const libColorConsole: (title: string, color: "red" | "orange" | "yellow" | "green" | "blue" | "purple", logs?: {
-    label: string;
-    value: any;
-}[] | any) => void;

package/dist/Browser/LibColorConsole/index.js

@@ -1,38 +0,0 @@
-/** @description console颜色打印
- * @param title 标题
- * @param color 颜色
- * @param logs 信息
- * @example
- * // 使用红色打印日志
- * libColorConsole("错误提示", "red", [{ label: "错误代码", value: 500 }]);
- *
- * // 使用蓝色打印简单日志
- * libColorConsole("信息", "blue", "操作成功");
- */
-export const libColorConsole = (title, color, logs = []) => {
-    const colors = {
-        red: "#c0392b",
-        orange: "#d35400",
-        yellow: "#f1c40f",
-        green: "#27ae60",
-        blue: "#2980b9",
-        purple: "#be2edd",
-    };
-    // 时间戳生成函数
-    const getTimestamp = () => {
-        const now = new Date();
-        const hour = String(now.getHours()).padStart(2, "0");
-        const minutes = String(now.getMinutes()).padStart(2, "0");
-        const seconds = String(now.getSeconds()).padStart(2, "0");
-        return `[${hour}:${minutes}:${seconds}]`;
-    };
-    if (Array.isArray(logs)) {
-        const v = logs.map((log) => {
-            return [`\n${log.label}：`, log.value];
-        });
-        console.log(`%c${getTimestamp()}-${title}`, `color: #fff;background: ${colors[color]}; font-size:14px;border-radius:5px;padding:0.25em;margin:0.5em 0`, ...v.flat(Infinity));
-    }
-    else {
-        console.log(`%c${getTimestamp()}-${title}`, `color: #fff;background: ${colors[color]}; font-size:14px;border-radius:5px;padding:0.25em;margin:0.5em 0`, logs);
-    }
-};