lyb-js 1.0.7 → 1.0.9

package/dist/{lib.d.ts → libJs.d.ts}

@@ -4,21 +4,21 @@ export declare const Base: {
      * @description 返回数据类型
      * @param v 需要判断类型的数据
      * @example
-     * libGetDataType(123); //"number"
-     * libGetDataType("hello"); //"string"
-     * libGetDataType([1, 2, 3]); //"array"
+     * libJsGetDataType(123); //"number"
+     * libJsGetDataType("hello"); //"string"
+     * libJsGetDataType([1, 2, 3]); //"array"
      */
-    libGetDataType: (v: any) => import("./Base/LibGetDataType").LibGetDataTypeReturnType;
+    libJsGetDataType: (v: any) => import("./Base/LibJsGetDataType").LibJsGetDataTypeReturnType;
     /**
      * @description 延时执行，切换到其他页面会暂停
      * @param delay 延时毫秒数
      * @param fn 延时执行函数
      * @example
-     * libPromiseTimeout(3000, () => {
+     * libJsPromiseTimeout(3000, () => {
      *   console.log("执行延时函数");
      * });
      */
-    libPromiseTimeout: (delay?: number, fn?: () => void) => Promise<void>;
+    libJsPromiseTimeout: (delay?: number, fn?: () => void) => Promise<void>;
 };
 /** @description 浏览器相关方法 */
 export declare const Browser: {
@@ -28,47 +28,47 @@ export declare const Browser: {
      * @param logs 信息
      * @example
      * //使用红色打印日志
-     * libColorConsole("错误提示", "red", [{ label: "错误代码", value: 500 }]);
+     * libJsColorConsole("错误提示", "red", [{ label: "错误代码", value: 500 }]);
      *
      * //使用蓝色打印简单日志
-     * libColorConsole("信息", "blue", "操作成功");
+     * libJsColorConsole("信息", "blue", "操作成功");
      */
-    libColorConsole: (title: string, color: "red" | "orange" | "yellow" | "green" | "blue" | "purple", logs?: {
+    libJsColorConsole: (title: string, color: "red" | "orange" | "yellow" | "green" | "blue" | "purple", logs?: {
         label: string;
         value: any;
     }[] | any) => void;
     /** @description 判断是否为移动设备
      * @example
-     * const isMobile = libIsMobile();
+     * const isMobile = libJsIsMobile();
      * console.log(isMobile); //true 或 false
      */
-    libIsMobile: () => boolean;
+    libJsIsMobile: () => boolean;
     /** @description 判断是否为平板
      * @example
-     * const isPad = libIsPad();
+     * const isPad = libJsIsPad();
      * console.log(isPad); //true 或 false
      */
-    libIsPad: () => boolean;
+    libJsIsPad: () => boolean;
     /** @description 获取浏览器地址栏参数
      * @example
-     * const params = libPathParams();
+     * const params = libJsPathParams();
      * console.log(params); //{ param1: "value1", param2: "value2" }
      */
-    libPathParams: () => Record<string, string>;
+    libJsPathParams: () => Record<string, string>;
     /** @description 动态设置网站标题及图标
      * @param title 网站标题
      * @param url 网站图标地址
      * @example
-     * libSetTitleIcon("我的网站", "https://example.com/favicon.ico");
+     * libJsSetTitleIcon("我的网站", "https://example.com/favicon.ico");
      */
-    libSetTitleIcon: (title: string, url: string) => void;
+    libJsSetTitleIcon: (title: string, url: string) => void;
     /** @description 网站标题交互，当从当前网页切换到其他网页，网站标题自动切换
      * @param backTitle 从其他网页返回时显示的标题
      * @param leaveTitle 从当前网页离开时显示的标题
      *  * @example
-     * libTagTitleTip("欢迎回来", "来和妲己玩耍吧！");
+     * libJsTagTitleTip("欢迎回来", "来和妲己玩耍吧！");
      */
-    libTagTitleTip: (backTitle: string, leaveTitle: string) => void;
+    libJsTagTitleTip: (backTitle: string, leaveTitle: string) => void;
 };
 /** @description 数据相关方法 */
 export declare const Data: {
@@ -77,51 +77,51 @@ export declare const Data: {
      * @param arr 需要拆分的数组
      * @param chunkSize 每个数组的元素数量
      * @example
-     * const chunks = libChunkArray([1, 2, 3, 4, 5, 6], 2);
+     * const chunks = libJsChunkArray([1, 2, 3, 4, 5, 6], 2);
      * console.log(chunks); //[[1, 2], [3, 4], [5, 6]]
      */
-    libChunkArray: <T>(arr: T[], chunkSize: number) => T[][];
+    libJsChunkArray: <T>(arr: T[], chunkSize: number) => T[][];
     /** @description 递归将JSON字符串深度解析为对象
      * @example
-     * const obj = libDeepJSONParse('{"a": 1, "b": "{\"c\": 2}"}');
+     * const obj = libJsDeepJSONParse('{"a": 1, "b": "{\"c\": 2}"}');
      * console.log(obj); //{ a: 1, b: { c: 2 } }
      */
-    libDeepJSONParse: <T>(data: any) => T;
+    libJsDeepJSONParse: <T>(data: any) => T;
     /**
      * @description 分类汇总，将数组对象按照指定键值整理成一个以键值为键名的对象
      * @param arr 要分组的数组
      * @param key 分组的键
      * @returns 分组后的对象
      * @example
-     * const grouped = libGroupArrayByKey([{ id: 1, name: 'A' }, { id: 2, name: 'B' }, { id: 1, name: 'C' }], 'id');
+     * const grouped = libJsGroupArrayByKey([{ 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' }] }
      */
-    libGroupArrayByKey: (arr: any[] | undefined, key: string) => any;
+    libJsGroupArrayByKey: (arr: any[] | undefined, key: string) => any;
     /**
      * @description 匹配电子邮件，可用于实时输入时，自动补全常用邮箱后缀
      * @param str 要匹配的字符串
      * @param emailList 电子邮件后缀列表
      * @returns 匹配结果数组
      * @example
-     * const emails = libMatchEmail("user", ["@gmail.com", "@yahoo.com"]);
+     * const emails = libJsMatchEmail("user", ["@gmail.com", "@yahoo.com"]);
      * console.log(emails); //["user@gmail.com", "user@yahoo.com"]
      */
-    libMatchEmail: (str: string, emailList: string[]) => string[];
+    libJsMatchEmail: (str: string, emailList: string[]) => string[];
     /** @description 数组乱序
      * @param arr 需要乱序的数组
      * @example
-     * const shuffled = libShuffleArray([1, 2, 3, 4, 5]);
+     * const shuffled = libJsShuffleArray([1, 2, 3, 4, 5]);
      * console.log(shuffled); //[3, 5, 2, 1, 4] （结果每次不同）
      */
-    libShuffleArray: <T>(arr: T[]) => T[];
+    libJsShuffleArray: <T>(arr: T[]) => T[];
     /** @description 数组元素整体步数移动
      * @param arr 移动的数组
      * @param step 负数为向后移动，正数为向前移动
      * @example
-     * const moved = libStepArray([1, 2, 3, 4, 5], 2);
+     * const moved = libJsStepArray([1, 2, 3, 4, 5], 2);
      * console.log(moved); //[4, 5, 1, 2, 3]
      */
-    libStepArray: <T>(arr: T[], step: number) => T[];
+    libJsStepArray: <T>(arr: T[], step: number) => T[];
 };
 /** @description 文件相关方法 */
 export declare const File: {
@@ -129,14 +129,14 @@ export declare const File: {
      * @param link 图片链接
      * @param name 图片名称
      * @example
-     * libDownloadImageLink("https://example.com/image.jpg", "downloaded-image.jpg");
+     * libJsDownloadImageLink("https://example.com/image.jpg", "downloaded-image.jpg");
      */
-    libDownloadImageLink: (link: string, name: string) => void;
+    libJsDownloadImageLink: (link: string, name: string) => void;
     /** @description 图片压缩
      * @param obj 压缩参数
      * @example
      * //图片压缩使用示例
-     * libImageOptimizerOptionsParams({
+     * libJsImageOptimizerOptionsParams({
      *   file: myFile,
      *   ratio: 0.8,
      *   width: 800,
@@ -149,15 +149,15 @@ export declare const File: {
      *   }
      * });
      */
-    libImageOptimizer: (obj: import("./File/LibImageOptimizer").LibImageOptimizerOptionsParams) => void;
+    libJsImageOptimizer: (obj: import("./File/LibJsImageOptimizer").LibJsImageOptimizerOptionsParams) => void;
     /**
      * @description 保存文件到本地
      * @param data 要保存的数据
      * @param name 文件名
      * @example
-     * libSaveJson(JSON.stringify({ key: "value" }), "example.json");
+     * libJsSaveJson(JSON.stringify({ key: "value" }), "example.json");
      */
-    libSaveJson: (data: BlobPart, name: string) => void;
+    libJsSaveJson: (data: BlobPart, name: string) => void;
 };
 /** @description 格式化相关方法 */
 export declare const Formatter: {
@@ -166,47 +166,47 @@ export declare const Formatter: {
      * @param bytes 字节数
      * @returns ['大小', '单位', '大小及单位']
      * @example
-     * const [size, unit, formatted] = libFormatterByte(2048);
+     * const [size, unit, formatted] = libJsFormatterByte(2048);
      * console.log(size, unit, formatted); //2.00 KB 2.00 KB
      */
-    libFormatterByte: (bytes: number) => (string | number)[];
+    libJsFormatterByte: (bytes: number) => (string | number)[];
     /**
      * @description 隐藏手机号码中间的四位数字
      * @param mobile 需要处理的手机号码
      * @example
-     * const masked = libMaskPhoneNumber("13812345678");
+     * const masked = libJsMaskPhoneNumber("13812345678");
      * console.log(masked); //138****5678
      */
-    libMaskPhoneNumber: (mobile: number | string) => string;
+    libJsMaskPhoneNumber: (mobile: number | string) => string;
     /**
      * @description 数字每三位添加逗号
      * @param num 需要格式化的数字
      * @param reserve 保留小数位数
      * @example
-     * const formatted = libNumComma(1234567.89);
+     * const formatted = libJsNumComma(1234567.89);
      * console.log(formatted); //1,234,567.89
      */
-    libNumComma: (num: number, reserve?: number) => string;
+    libJsNumComma: (num: number, reserve?: number) => string;
     /** @description 将大于1000的数字使用k为单位
      * @param num 数字
      * @param units 单位组，key为单位，value为格式化阈值
      * @returns [数字, 单位]
      * @example
-     * const [value, unit] = libNumberUnit(1500, { K: 1000, M: 1000000 });
+     * const [value, unit] = libJsNumberUnit(1500, { K: 1000, M: 1000000 });
      * console.log(value, unit); //1.50 K
      */
-    libNumberUnit: (num: number, units: import("./Formatter/LibNumberUnit").LibNumberUnitParams) => string[];
+    libJsNumberUnit: (num: number, units: import("./Formatter/LibJsNumberUnit").LibJsNumberUnitParams) => string[];
     /**
      * @description 将秒数格式化为中文时间描述，支持扩展到年和月
      * @param seconds 秒数
      * @returns 格式化后的中文时间
      * @example
-     * libSecondsFormatterChinese(100000); //"1天3小时46分40秒"
-     * libSecondsFormatterChinese(31536000); //"1年"
-     * libSecondsFormatterChinese(3600); //"1小时"
-     * libSecondsFormatterChinese(90); //"1分30秒"
+     * libJsSecondsFormatterChinese(100000); //"1天3小时46分40秒"
+     * libJsSecondsFormatterChinese(31536000); //"1年"
+     * libJsSecondsFormatterChinese(3600); //"1小时"
+     * libJsSecondsFormatterChinese(90); //"1分30秒"
      */
-    libSecondsFormatterChinese: (seconds: number) => string;
+    libJsSecondsFormatterChinese: (seconds: number) => string;
 };
 /** @description 数学相关方法 */
 export declare const Math: {
@@ -216,31 +216,31 @@ export declare const Math: {
      * @returns 计算结果
      *
      * @example
-     * const result = libCalculateExpression("(1+2)-(3*4)/5");
+     * const result = libJsCalculateExpression("(1+2)-(3*4)/5");
      * console.log(result); //0.6
      */
-    libCalculateExpression: (expression: string, point?: number) => number;
+    libJsCalculateExpression: (expression: string, point?: number) => number;
     /**
      * @description 角度和弧度互相转换
      * @param value 角度值或弧度值
      * @param type 角度类型或弧度类型
      * @example
      * //角度转弧度
-     * libConvertAngle(90, "rad"); //返回 1.5708... (π/2)
+     * libJsConvertAngle(90, "rad"); //返回 1.5708... (π/2)
      *
      * //弧度转角度
-     * libConvertAngle(Math.PI, "deg"); //返回 180
+     * libJsConvertAngle(Math.PI, "deg"); //返回 180
      */
-    libConvertAngle: (value: number, type: "rad" | "deg") => number;
+    libJsConvertAngle: (value: number, type: "rad" | "deg") => number;
     /** @description 计算两点角度
      * @param coord1 起点坐标
      * @param coord2 终点坐标
      * @example
-     * 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
+     * libJsCoordsAngle({ x: 0, y: 0 }, { x: 1, y: 0 }); //0
+     * libJsCoordsAngle({ x: 0, y: 0 }, { x: 1, y: 1 }); //45
+     * libJsCoordsAngle({ x: 0, y: 0 }, { x: 0, y: 1 }); //90
      */
-    libCoordsAngle: (coord1: {
+    libJsCoordsAngle: (coord1: {
         x: number;
         y: number;
     }, coord2: {
@@ -251,11 +251,11 @@ export declare const Math: {
      * @param coord1 起点坐标
      * @param coord2 终点坐标
      * @example
-     * 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
+     * libJsCoordsDistance({ x: 0, y: 0 }, { x: 3, y: 4 }); //5
+     * libJsCoordsDistance({ x: 1, y: 1 }, { x: 4, y: 5 }); //5
+     * libJsCoordsDistance({ x: 0, y: 0 }, { x: 0, y: 0 }); //0
      */
-    libCoordsDistance: (coord1: {
+    libJsCoordsDistance: (coord1: {
         x: number;
         y: number;
     }, coord2: {
@@ -267,11 +267,11 @@ export declare const Math: {
      * @param num2 第二个数
      * @param operator 运算符，支持加减乘除
      * @example
-     * libDecimal(10, 3, "+"); //13
-     * libDecimal(10, 3, "-"); //7
-     * libDecimal(10, 3, "/", 2); //3.33
+     * libJsDecimal(10, 3, "+"); //13
+     * libJsDecimal(10, 3, "-"); //7
+     * libJsDecimal(10, 3, "/", 2); //3.33
      */
-    libDecimal: (num1: number, num2: number, operator: "+" | "-" | "*" | "/", point?: number) => number;
+    libJsDecimal: (num1: number, num2: number, operator: "+" | "-" | "*" | "/", point?: number) => number;
 };
 /** @description 杂项相关方法 */
 export declare const Misc: {
@@ -286,22 +286,22 @@ export declare const Misc: {
      *   { key: "username", verify: /^[a-zA-Z0-9]{3,}$/, msg: "用户名不合法", name: "用户名" },
      *   { key: "email", verify: /^\S+@\S+\.\S+$/, msg: "邮箱格式不正确", name: "邮箱" },
      * ];
-     * libRegFormValidate(form, rules);
+     * libJsRegFormValidate(form, rules);
      * //返回结果: []
      *
      * const invalidForm = { username: "jo", email: "invalid-email" };
-     * libRegFormValidate(invalidForm, rules);
+     * libJsRegFormValidate(invalidForm, rules);
      * //返回结果: [
      * //  { key: "username", msg: "用户名不合法", name: "用户名" },
      * //  { key: "email", msg: "邮箱格式不正确", name: "邮箱" }
      * //]
      */
-    libRegFormValidate: (form: Record<string, any>, rules: Array<{
+    libJsRegFormValidate: (form: Record<string, any>, rules: Array<{
         key: string;
         verify: RegExp | ((value: any) => boolean);
         msg: string;
         name: string;
-    }>) => import("./Misc/LibRegFormValidate").ValidationResult[];
+    }>) => import("./Misc/LibJsRegFormValidate").ValidationResult[];
     /** @description 请求失败重连
      * @param promiseFn 请求函数
      * @param maxRetries 最大重试次数
@@ -310,7 +310,7 @@ export declare const Misc: {
      * @example
      * const requestFn = (params: { url: string }) => fetch(params.url).then(res => res.json());
      * const params = { url: "https://api.example.com/data" };
-     * libRetryRequest({
+     * libJsRetryRequest({
      *   promiseFn: requestFn,
      *   params,
      *   maxRetries: 5,
@@ -319,7 +319,7 @@ export declare const Misc: {
      * .then(data => console.log(data))
      * .catch(err => console.error(err));
      */
-    libRetryRequest: <T>({ promiseFn, maxRetries, retryDelay, params, }: {
+    libJsRetryRequest: <T>({ promiseFn, maxRetries, retryDelay, params, }: {
         promiseFn: (params?: any) => Promise<T>;
         params?: any;
         maxRetries?: number;
@@ -332,37 +332,37 @@ export declare const Random: {
     /** @description 百分比概率结果
      * @param probability 触发概率，百分比，0-100
      * @example
-     * libProbabilityResult(50); //50% 概率为 true
-     * libProbabilityResult(80); //80% 概率为 true
-     * libProbabilityResult(100); //100% 概率为 true
+     * libJsProbabilityResult(50); //50% 概率为 true
+     * libJsProbabilityResult(80); //80% 概率为 true
+     * libJsProbabilityResult(100); //100% 概率为 true
      */
-    libProbabilityResult: (probability: number) => boolean;
+    libJsProbabilityResult: (probability: number) => boolean;
     /** @description 随机数
      * @param min 最小值
      * @param max 最大值
      * @param num 保留小数位数
      * @example
-     * libRandom(1, 10); //1 到 10 之间的随机整数
-     * libRandom(1, 10, 2); //1 到 10 之间保留两位小数的随机数
-     * libRandom(5, 5, 3); //返回 5.000
+     * libJsRandom(1, 10); //1 到 10 之间的随机整数
+     * libJsRandom(1, 10, 2); //1 到 10 之间保留两位小数的随机数
+     * libJsRandom(5, 5, 3); //返回 5.000
      */
-    libRandom: (min: number, max: number, num?: number) => number;
+    libJsRandom: (min: number, max: number, num?: number) => number;
     /** @description 随机 RGBA 颜色
      * @param alpha 透明度
      * @example
-     * libRandomColor(); //生成随机的 RGBA 颜色，默认透明度 1
-     * libRandomColor(0.5); //生成随机的 RGBA 颜色，透明度为 0.5
+     * libJsRandomColor(); //生成随机的 RGBA 颜色，默认透明度 1
+     * libJsRandomColor(0.5); //生成随机的 RGBA 颜色，透明度为 0.5
      */
-    libRandomColor: (alpha?: number) => string;
+    libJsRandomColor: (alpha?: number) => string;
     /** @description 随机生成n个指定范围的随机数数组
      * @param min 最小值
      * @param max 最大值
      * @param count 数组长度
      * @example
-     * libUniqueRandomNumbers(1, 10, 5); //从 1 到 10 中随机生成 5 个唯一数字
-     * libUniqueRandomNumbers(1, 100, 10); //从 1 到 100 中随机生成 10 个唯一数字
+     * libJsUniqueRandomNumbers(1, 10, 5); //从 1 到 10 中随机生成 5 个唯一数字
+     * libJsUniqueRandomNumbers(1, 100, 10); //从 1 到 100 中随机生成 10 个唯一数字
      */
-    libUniqueRandomNumbers: (min: number, max: number, count: number) => number[];
+    libJsUniqueRandomNumbers: (min: number, max: number, count: number) => number[];
 };
 /** @description 时间相关方法 */
 export declare const Time: {
@@ -372,23 +372,23 @@ export declare const Time: {
      * @param unit 判断单位
      * @returns 0-同一单位时间 1-新单位时间 -1时间戳大于当前时间
      */
-    libSameTimeCheck: (timestamp: number, unit: import("dayjs").OpUnitType) => 0 | 1 | -1;
+    libJsSameTimeCheck: (timestamp: number, unit: import("dayjs").OpUnitType) => 0 | 1 | -1;
     /** @description 时间差计算
      * @param timestamp 毫秒时间戳
      * @example
-     * libTimeAgotamp(Date.now() - 3600000); //"1 小时前"
-     * libTimeAgotamp(Date.now() - 86400000); //"1 天前"
-     * libTimeAgotamp(Date.now() - 31536000000); //"1 年前"
-     * libTimeAgotamp(Date.now() - 10000); //"刚刚"
+     * libJsTimeAgotamp(Date.now() - 3600000); //"1 小时前"
+     * libJsTimeAgotamp(Date.now() - 86400000); //"1 天前"
+     * libJsTimeAgotamp(Date.now() - 31536000000); //"1 年前"
+     * libJsTimeAgotamp(Date.now() - 10000); //"刚刚"
      */
-    libTimeAgo: (timestamp: number) => string;
+    libJsTimeAgo: (timestamp: number) => string;
     /**
      * @description 根据当前时间返回问候语
      * @param greet 自定义问候语对象
      * @example
-     * libTimeGreeting(); //根据当前时间返回默认问候语
-     * libTimeGreeting({ morning: "早安" }); //自定义早上问候语
-     * libTimeGreeting({ afternoon: "午后好" }); //自定义下午问候语
+     * libJsTimeGreeting(); //根据当前时间返回默认问候语
+     * libJsTimeGreeting({ morning: "早安" }); //自定义早上问候语
+     * libJsTimeGreeting({ afternoon: "午后好" }); //自定义下午问候语
      */
-    libTimeGreeting: (greet?: import("./Time/LibTimeGreeting").LibTimeGreetingParams) => string;
+    libJsTimeGreeting: (greet?: import("./Time/LibJsTimeGreeting").LibTimeGreetingParams) => string;
 };