@ivujs/i-utils 2.0.0 → 2.1.0

package/dist/es/storage/localStorage.d.ts

@@ -1,21 +1,21 @@
 /**
  * 通过key从localStorage缓存中获取数据
- * @param {String} key key值
- * @returns {String} 返回数据
+ * @param {string} key key值
+ * @returns {string} 返回数据
  */
-export function getLocalStorage(key: string): string;
+export declare function getLocalStorage(key: string): string | undefined;
 /**
  * 设置localStorage缓存数据
- * @param {String} key key值
- * @param {String} value value值
+ * @param {string} key key值
+ * @param {string} value value值
  */
-export function setLocalStorage(key: string, value: string): void;
+export declare function setLocalStorage(key: string, value: string): void;
 /**
  * 通过key从localStorage缓存中删除数据
- * @param {String} key key值
+ * @param {string} key key值
  */
-export function removeLocalStorage(key: string): void;
+export declare function removeLocalStorage(key: string): void;
 /**
  * 清空localStorage缓存中所有数据
  */
-export function clearLocalStorage(): void;
+export declare function clearLocalStorage(): void;

package/dist/es/storage/localStorage.mjs

@@ -1,23 +1,23 @@
 /* localStorage存储 */
 /**
  * 通过key从localStorage缓存中获取数据
- * @param {String} key key值
- * @returns {String} 返回数据
+ * @param {string} key key值
+ * @returns {string} 返回数据
  */
 function getLocalStorage(key) {
     return window.localStorage.getItem(key) || undefined;
 }
 /**
  * 设置localStorage缓存数据
- * @param {String} key key值
- * @param {String} value value值
+ * @param {string} key key值
+ * @param {string} value value值
  */
 function setLocalStorage(key, value) {
     window.localStorage.setItem(key, value);
 }
 /**
  * 通过key从localStorage缓存中删除数据
- * @param {String} key key值
+ * @param {string} key key值
  */
 function removeLocalStorage(key) {
     window.localStorage.removeItem(key);

package/dist/es/storage/sessionStorage.d.ts

@@ -1,21 +1,21 @@
 /**
  * 通过key从sessionStorage缓存中获取数据
- * @param {String} key key值
- * @returns {String} 返回数据
+ * @param {string} key key值
+ * @returns {string} 返回数据
  */
-export function getSessionStorage(key: string): string;
+export declare function getSessionStorage(key: string): string | undefined;
 /**
  * 设置sessionStorage缓存数据
- * @param {String} key key值
- * @param {String} value value值
+ * @param {string} key key值
+ * @param {string} value value值
  */
-export function setSessionStorage(key: string, value: string): void;
+export declare function setSessionStorage(key: string, value: string): void;
 /**
  * 通过key从sessionStorage缓存中删除数据
- * @param {String} key key值
+ * @param {string} key key值
  */
-export function removeSessionStorage(key: string): void;
+export declare function removeSessionStorage(key: string): void;
 /**
  * 清空sessionStorage缓存中所有数据
  */
-export function clearSessionStorage(): void;
+export declare function clearSessionStorage(): void;

package/dist/es/storage/sessionStorage.mjs

@@ -1,23 +1,23 @@
 /* sessionStorage存储 */
 /**
  * 通过key从sessionStorage缓存中获取数据
- * @param {String} key key值
- * @returns {String} 返回数据
+ * @param {string} key key值
+ * @returns {string} 返回数据
  */
 function getSessionStorage(key) {
-    return window.sessionStorage.getItem(key) || "";
+    return window.sessionStorage.getItem(key) || undefined;
 }
 /**
  * 设置sessionStorage缓存数据
- * @param {String} key key值
- * @param {String} value value值
+ * @param {string} key key值
+ * @param {string} value value值
  */
 function setSessionStorage(key, value) {
     window.sessionStorage.setItem(key, value);
 }
 /**
  * 通过key从sessionStorage缓存中删除数据
- * @param {String} key key值
+ * @param {string} key key值
  */
 function removeSessionStorage(key) {
     window.sessionStorage.removeItem(key);

package/dist/es/string/index.d.ts

@@ -1,121 +1,124 @@
+/**
+ * @module 字符串
+ */
 /**
  * 字符串中是否包含指定的元素
- * @param {String} value 包含的元素
- * @param {String} str 查找的字符串
- * @returns {Boolean} 返回true和false
+ * @param {string} value 包含的元素
+ * @param {string} str 查找的字符串
+ * @returns {boolean} 返回true和false
  */
-export function inString(value: string, str: string): boolean;
+export declare function inString(value: string, str: string): boolean;
 /**
  * 去除字符串前后位置空格
- * @param {String} value 参数
- * @returns {String} 返回处理后的字符串
+ * @param {string} value 参数
+ * @returns {string} 返回处理后的字符串
  */
-export function trim(value: string): string;
+export declare function trim(value: string): string;
 /**
  * 去除字符串开始位置的空格
- * @param {String} value 参数
- * @returns {String} 返回处理后的字符串
+ * @param {string} value 参数
+ * @returns {string} 返回处理后的字符串
  */
-export function trimStart(value: string): string;
+export declare function trimStart(value: string): string;
 /**
  * 去除字符串结束位置的空格
- * @param {String} value 参数
- * @returns {String} 返回处理后的字符串
+ * @param {string} value 参数
+ * @returns {string} 返回处理后的字符串
  */
-export function trimEnd(value: string): string;
+export declare function trimEnd(value: string): string;
 /**
  * 去除字符串中全部的空格
- * @param {String} value 参数
- * @returns {String} 返回处理后的字符串
+ * @param {string} value 参数
+ * @returns {string} 返回处理后的字符串
  */
-export function trimAll(value: string): string;
+export declare function trimAll(value: string): string;
 /**
  * 替换所有指定字符串为新的字符串
- * @param {String} value 参数
- * @param {String} oldSubstr 需要替换的字符串
- * @param {String} newSubstr 替换后的字符串
- * @returns {String} 返回处理后的字符串
+ * @param {string} value 参数
+ * @param {string} oldSubstr 需要替换的字符串
+ * @param {string} newSubstr 替换后的字符串
+ * @returns {string} 返回处理后的字符串
  */
-export function replaceAll(value: string, oldSubstr: string, newSubstr: string): string;
+export declare function replaceAll(value: string, oldSubstr: string, newSubstr: string): string;
 /**
  * 字符串转大写
- * @param {String} value 参数
- * @returns {String} 返回处理后的字符串
+ * @param {string} value 参数
+ * @returns {string} 返回处理后的字符串
  */
-export function toUpperCase(value: string): string;
+export declare function toUpperCase(value: string): string;
 /**
  * 字符串转小写
- * @param {String} value 参数
- * @returns {String} 返回处理后的字符串
+ * @param {string} value 参数
+ * @returns {string} 返回处理后的字符串
  */
-export function toLowerCase(value: string): string;
+export declare function toLowerCase(value: string): string;
 /**
  * 转为 snake_case 下划线命名
  * @description 支持 驼峰命名，短横命名，帕斯卡命名
- * @param {String} value 参数
- * @returns {String} 返回处理后的字符串
+ * @param {string} value 参数
+ * @returns {string} 返回处理后的字符串
  */
-export function toSnakeCase(value: string): string;
+export declare function toSnakeCase(value: string): string | undefined;
 /**
  * 转为 kebab-case 短横命名
  * @description 支持 下划线，驼峰命名，帕斯卡命名
- * @param {String} value 参数
- * @returns {String} 返回处理后的字符串
+ * @param {string} value 参数
+ * @returns {string} 返回处理后的字符串
  */
-export function toKebabCase(value: string): string;
+export declare function toKebabCase(value: string): string | undefined;
 /**
  * 转为 camelCase 驼峰命名
  * @description 支持 下划线命名，短横命名，帕斯卡命名
- * @param {String} value 参数
- * @returns {String} 返回处理后的字符串
+ * @param {string} value 参数
+ * @returns {string} 返回处理后的字符串
  */
-export function toCamelCase(value: string): string;
+export declare function toCamelCase(value: string): string;
 /**
  * 转为 PascalCase 帕斯卡命名
  * @description 支持 下划线命名，短横命名，驼峰命名
- * @param {String} value 参数
- * @returns {String} 返回处理后的字符串
+ * @param {string} value 参数
+ * @returns {string} 返回处理后的字符串
  */
-export function toPascalCase(value: string): string;
+export declare function toPascalCase(value: string): string;
 /**
  * 数字前补齐0达到指定位数
  * @description 相当于原生的 padStart(2,'0')
- * @param {Number|String} value 补零的数字
- * @param {Number} maxLength 补齐0后的最大长度，默认2位
- * @returns {String} 返回补0后指定位数的字符串
+ * @param {number|string} value 补零的数字
+ * @param {number} maxLength 补齐0后的最大长度，默认2位
+ * @returns {string} 返回补0后指定位数的字符串
  */
-export function zeroStart(value: number | string, maxLength?: number): string;
+export declare function zeroStart(value: string, maxLength?: number): string;
 /**
  * 数字后补齐0达到指定位数
  * @description 相当于原生的 padEnd(2,'0')
- * @param {Number|String} value 补零的数字
- * @param {Number} maxLength 补齐0后的最大长度，默认2位
- * @returns {String} 返回补0后指定位数的字符串
+ * @param {number|string} value 补零的数字
+ * @param {number} maxLength 补齐0后的最大长度，默认2位
+ * @returns {string} 返回补0后指定位数的字符串
  */
-export function zeroEnd(value: number | string, maxLength?: number): string;
+export declare function zeroEnd(value: string, maxLength?: number): string;
 /**
  * 格式化为标题样式
- * @param {String} value 字符串值
- * @returns {String} 返回格式化后的标题样式
+ * @param {string} value 字符串值
+ * @returns {string} 返回格式化后的标题样式
  */
-export function formatTitle(value: string): string;
+export declare function formatTitle(value: string): string;
 /**
  * 格式化字符串模版
- * @param {String} value 字符串值
+ * @param {string} value 字符串值
  * @param {Object} data 模版数据
- * @returns {String} 返回格式化后的模版字符串
+ * @returns {string} 返回格式化后的模版字符串
  */
-export function formatTemplate(value: string, data: Object): string;
+export declare function formatTemplate(value: string, data: Record<any, any>): string;
 /**
  * 格式化千分位数字
  * @description 支持任意数据传参，如果非数字则不会格式化，并返回原数据
- * @param {Number|String} num 数字
- * @returns {String} 返回格式化后的千分位数字
+ * @param {number|string} num 数字
+ * @returns {string} 返回格式化后的千分位数字
  */
-export function formatThousand(num: number | string): string;
+export declare function formatThousand(num: number | string): string;
 /**
  * 格式化人民币金额大写
- * @param {Number|String} money 金额
- * @returns {String} 返回金额大写
+ * @param {number|string} money 金额
+ * @returns {string} 返回金额大写
  */
-export function formatRmbChinese(money: number | string): string;
+export declare function formatRmbChinese(money: number | string): string;

package/dist/es/string/index.mjs

@@ -1,51 +1,54 @@
+/**
+ * @module 字符串
+ */
 /* 字符串处理 */
 /**
  * 字符串中是否包含指定的元素
- * @param {String} value 包含的元素
- * @param {String} str 查找的字符串
- * @returns {Boolean} 返回true和false
+ * @param {string} value 包含的元素
+ * @param {string} str 查找的字符串
+ * @returns {boolean} 返回true和false
  */
 function inString(value, str) {
     return str.includes(value);
 }
 /**
  * 去除字符串前后位置空格
- * @param {String} value 参数
- * @returns {String} 返回处理后的字符串
+ * @param {string} value 参数
+ * @returns {string} 返回处理后的字符串
  */
 function trim(value) {
     return value.replace(/(^\s*)|(\s*$)/g, "");
 }
 /**
  * 去除字符串开始位置的空格
- * @param {String} value 参数
- * @returns {String} 返回处理后的字符串
+ * @param {string} value 参数
+ * @returns {string} 返回处理后的字符串
  */
 function trimStart(value) {
     return value.replace(/(^\s*)/g, "");
 }
 /**
  * 去除字符串结束位置的空格
- * @param {String} value 参数
- * @returns {String} 返回处理后的字符串
+ * @param {string} value 参数
+ * @returns {string} 返回处理后的字符串
  */
 function trimEnd(value) {
     return value.replace(/(\s*$)/g, "");
 }
 /**
  * 去除字符串中全部的空格
- * @param {String} value 参数
- * @returns {String} 返回处理后的字符串
+ * @param {string} value 参数
+ * @returns {string} 返回处理后的字符串
  */
 function trimAll(value) {
     return value.replace(/\s+/g, "");
 }
 /**
  * 替换所有指定字符串为新的字符串
- * @param {String} value 参数
- * @param {String} oldSubstr 需要替换的字符串
- * @param {String} newSubstr 替换后的字符串
- * @returns {String} 返回处理后的字符串
+ * @param {string} value 参数
+ * @param {string} oldSubstr 需要替换的字符串
+ * @param {string} newSubstr 替换后的字符串
+ * @returns {string} 返回处理后的字符串
  */
 function replaceAll(value, oldSubstr, newSubstr) {
     return value.replace(new RegExp(oldSubstr, "gm"), newSubstr);
@@ -53,25 +56,25 @@ function replaceAll(value, oldSubstr, newSubstr) {
 /* 字符串转换 */
 /**
  * 字符串转大写
- * @param {String} value 参数
- * @returns {String} 返回处理后的字符串
+ * @param {string} value 参数
+ * @returns {string} 返回处理后的字符串
  */
 function toUpperCase(value) {
     return String(value).toLocaleUpperCase();
 }
 /**
  * 字符串转小写
- * @param {String} value 参数
- * @returns {String} 返回处理后的字符串
+ * @param {string} value 参数
+ * @returns {string} 返回处理后的字符串
  */
 function toLowerCase(value) {
-    String(value).toLocaleLowerCase();
+    return String(value).toLocaleLowerCase();
 }
 /**
  * 转为 snake_case 下划线命名
  * @description 支持 驼峰命名，短横命名，帕斯卡命名
- * @param {String} value 参数
- * @returns {String} 返回处理后的字符串
+ * @param {string} value 参数
+ * @returns {string} 返回处理后的字符串
  */
 function toSnakeCase(value) {
     // 驼峰
@@ -91,8 +94,8 @@ function toSnakeCase(value) {
 /**
  * 转为 kebab-case 短横命名
  * @description 支持 下划线，驼峰命名，帕斯卡命名
- * @param {String} value 参数
- * @returns {String} 返回处理后的字符串
+ * @param {string} value 参数
+ * @returns {string} 返回处理后的字符串
  */
 function toKebabCase(value) {
     // 下划线
@@ -105,15 +108,15 @@ function toKebabCase(value) {
     }
     // 帕斯卡
     if (/^[A-Z]$/.test(value.charAt(0)) && !(value.indexOf("-") > 0 || value.indexOf("_") > 0)) {
-        let newStr = value.charAt(0).toLowerCase() + value.slice(1);
+        const newStr = value.charAt(0).toLowerCase() + value.slice(1);
         return newStr.replace(/([A-Z])/g, "-$1").toLowerCase();
     }
 }
 /**
  * 转为 camelCase 驼峰命名
  * @description 支持 下划线命名，短横命名，帕斯卡命名
- * @param {String} value 参数
- * @returns {String} 返回处理后的字符串
+ * @param {string} value 参数
+ * @returns {string} 返回处理后的字符串
  */
 function toCamelCase(value) {
     // 下划线
@@ -140,20 +143,20 @@ function toCamelCase(value) {
 /**
  * 转为 PascalCase 帕斯卡命名
  * @description 支持 下划线命名，短横命名，驼峰命名
- * @param {String} value 参数
- * @returns {String} 返回处理后的字符串
+ * @param {string} value 参数
+ * @returns {string} 返回处理后的字符串
  */
 function toPascalCase(value) {
     // 下划线
     if (value.indexOf("_") > 0) {
-        let newStr = value.replace(/\_(\w)/g, function (all, letter) {
+        const newStr = value.replace(/\_(\w)/g, function (all, letter) {
             return letter.toUpperCase();
         });
         return newStr.charAt(0).toUpperCase() + newStr.slice(1);
     }
     // 短横
     else if (value.indexOf("-") > 0) {
-        let newStr = value.replace(/\-(\w)/g, function (all, letter) {
+        const newStr = value.replace(/\-(\w)/g, function (all, letter) {
             return letter.toUpperCase();
         });
         return newStr.charAt(0).toUpperCase() + newStr.slice(1);
@@ -171,9 +174,9 @@ function toPascalCase(value) {
 /**
  * 数字前补齐0达到指定位数
  * @description 相当于原生的 padStart(2,'0')
- * @param {Number|String} value 补零的数字
- * @param {Number} maxLength 补齐0后的最大长度，默认2位
- * @returns {String} 返回补0后指定位数的字符串
+ * @param {number|string} value 补零的数字
+ * @param {number} maxLength 补齐0后的最大长度，默认2位
+ * @returns {string} 返回补0后指定位数的字符串
  */
 function zeroStart(value, maxLength = 2) {
     let len = value.toString().length;
@@ -186,9 +189,9 @@ function zeroStart(value, maxLength = 2) {
 /**
  * 数字后补齐0达到指定位数
  * @description 相当于原生的 padEnd(2,'0')
- * @param {Number|String} value 补零的数字
- * @param {Number} maxLength 补齐0后的最大长度，默认2位
- * @returns {String} 返回补0后指定位数的字符串
+ * @param {number|string} value 补零的数字
+ * @param {number} maxLength 补齐0后的最大长度，默认2位
+ * @returns {string} 返回补0后指定位数的字符串
  */
 function zeroEnd(value, maxLength = 2) {
     let len = value.toString().length;
@@ -200,8 +203,8 @@ function zeroEnd(value, maxLength = 2) {
 }
 /**
  * 格式化为标题样式
- * @param {String} value 字符串值
- * @returns {String} 返回格式化后的标题样式
+ * @param {string} value 字符串值
+ * @returns {string} 返回格式化后的标题样式
  */
 function formatTitle(value) {
     if (!value)
@@ -215,9 +218,9 @@ function formatTitle(value) {
 }
 /**
  * 格式化字符串模版
- * @param {String} value 字符串值
+ * @param {string} value 字符串值
  * @param {Object} data 模版数据
- * @returns {String} 返回格式化后的模版字符串
+ * @returns {string} 返回格式化后的模版字符串
  */
 function formatTemplate(value, data) {
     if (!value)
@@ -229,36 +232,36 @@ function formatTemplate(value, data) {
 /**
  * 格式化千分位数字
  * @description 支持任意数据传参，如果非数字则不会格式化，并返回原数据
- * @param {Number|String} num 数字
- * @returns {String} 返回格式化后的千分位数字
+ * @param {number|string} num 数字
+ * @returns {string} 返回格式化后的千分位数字
  */
 function formatThousand(num) {
-    if (!parseFloat(num))
-        return num;
+    if (!parseFloat(String(num)))
+        return String(num);
     num = String(num);
-    let regex = num.indexOf(".") > -1 ? /(\d)(?=(\d{3})+\.)/g : /(\d)(?=(?:\d{3})+$)/g;
+    const regex = num.indexOf(".") > -1 ? /(\d)(?=(\d{3})+\.)/g : /(\d)(?=(?:\d{3})+$)/g;
     return num.replace(regex, "$1,");
 }
 /**
  * 格式化人民币金额大写
- * @param {Number|String} money 金额
- * @returns {String} 返回金额大写
+ * @param {number|string} money 金额
+ * @returns {string} 返回金额大写
  */
 function formatRmbChinese(money) {
     // 汉字的数字
-    let cnNums = ["零", "壹", "贰", "叁", "肆", "伍", "陆", "柒", "捌", "玖"];
+    const cnNums = ["零", "壹", "贰", "叁", "肆", "伍", "陆", "柒", "捌", "玖"];
     // 基本单位
-    let cnIntRadiance = ["", "拾", "佰", "仟"];
+    const cnIntRadiance = ["", "拾", "佰", "仟"];
     // 对应整数部分扩展单位
-    let cnIntUnits = ["", "万", "亿", "兆"];
+    const cnIntUnits = ["", "万", "亿", "兆"];
     // 对应小数部分单位
-    let cnDecUnits = ["角", "分", "毫", "厘"];
+    const cnDecUnits = ["角", "分", "毫", "厘"];
     // 整数金额时后面跟的字符
-    let cnInteger = "整";
+    const cnInteger = "整";
     // 整型完以后的单位
-    let cnIntLast = "元";
+    const cnIntLast = "元";
     // 最大处理的数字
-    let maxNum = Number("999999999999999.9999");
+    const maxNum = Number("999999999999999.9999");
     // 金额整数部分
     let integerNum;
     // 金额小数部分
@@ -271,7 +274,7 @@ function formatRmbChinese(money) {
         // 不能用==
         return "";
     }
-    money = parseFloat(money);
+    money = parseFloat(String(money));
     if (money >= maxNum) {
         // 超出最大处理数字，抛出异常
         throw new Error("Calculated number overflow!");
@@ -294,12 +297,12 @@ function formatRmbChinese(money) {
     // 获取整型部分转换
     if (parseInt(integerNum, 10) > 0) {
         let zeroCount = 0;
-        let IntLen = integerNum.length;
+        const IntLen = integerNum.length;
         for (let i = 0; i < IntLen; i++) {
-            let n = integerNum.substr(i, 1);
-            let p = IntLen - i - 1;
-            let q = p / 4;
-            let m = p % 4;
+            const n = integerNum.substr(i, 1);
+            const p = IntLen - i - 1;
+            const q = p / 4;
+            const m = p % 4;
             if (n === "0") {
                 zeroCount++;
             }
@@ -319,9 +322,9 @@ function formatRmbChinese(money) {
     }
     // 小数部分
     if (decimalNum !== "") {
-        let decLen = decimalNum.length;
+        const decLen = decimalNum.length;
         for (let i = 0; i < decLen; i++) {
-            let n = decimalNum.substr(i, 1);
+            const n = decimalNum.substr(i, 1);
             if (n !== "0") {
                 chineseStr += cnNums[Number(n)] + cnDecUnits[i];
             }