@ivujs/i-utils 2.0.0 → 2.1.0

package/README.md

@@ -5,20 +5,20 @@
 
 🔥 **i-utils** 🔥是一款功能强大、高效的一站式前端模块化 **JavaScript** 工具库，支持 `Typescript` 导入，
 其集成了众多日常开发中用到的方法，覆盖`字符串`，`数组`，`数学`，`文件`，`数学`，`文件`，`加解密算法`，`脱敏`,`分页`，
-`浏览器 Cookie`，`浏览器 Clipboard`，`浏览器 Dom`，`微信小程序工具`等多个模块，同时支持`es模块化`、`umd浏览器环境`、
+`浏览器 Cookie`，`浏览器 Clipboard`，`浏览器 Dom`等多个模块，同时支持`es模块化`、`umd浏览器环境`、
 `require服务端环境`，满足不同场景的开发需求，大幅提升开发效率。
 
 ### 📦 安装
 
 ```bash
 # npm
-npm i @ivu-plus/i-utils --save
+npm i @ivujs/i-utils --save
 
 # pnpm
-pnpm i @ivu-plus/i-utils --save
+pnpm i @ivujs/i-utils --save
 
 # yarn
-yarn add @ivu-plus/i-utils --save
+yarn add @ivujs/i-utils --save
 ```
 
 ### 🎨 使用
@@ -27,25 +27,25 @@ yarn add @ivu-plus/i-utils --save
 
 ```javascript
 // 按需引入
-import { testLoaded } from "@ivu-plus/i-utils";
+import { testLoaded } from "@ivujs/i-utils";
 
 testLoaded();
 
 // 全量引入
-import * as iUtils from "@ivu-plus/i-utils";
+import * as iUtils from "@ivujs/i-utils";
 
 iUtils.testLoaded();
 ```
 
-#### commonjs 服务端环境
+#### cjs 服务端环境
 
 ```javascript
 // 全量引入
-const iUtils = require("@ivu-plus/i-utils");
+const iUtils = require("@ivujs/i-utils");
 iUtils.testLoaded();
 
 // 按需引入
-const { testLoaded } = require("@ivu-plus/i-utils");
+const { testLoaded } = require("@ivujs/i-utils");
 testLoaded();
 ```
 
@@ -73,7 +73,7 @@ testLoaded();
 
 #### 自动导入
 
-需要使用额外的插件来实现自动导入，`IUtilsResolver`解析器支持 `Vite` 和 `Webpack` 工具。
+需要使用额外的插件来实现自动导入，`IUtilsResolver`解析器支持在 `Vite` 和 `Webpack` 工具中使用。
 
 首先需要安装自动导入插件
 
@@ -87,7 +87,7 @@ pnpm install unplugin-auto-import -D
 ```javascript
 import { defineConfig } from "vite";
 import AutoImport from "unplugin-auto-import/vite";
-import { IUtilsResolver } from "@ivu-plus/i-utils/resolver";
+import { IUtilsResolver } from "@ivujs/i-utils/resolver";
 
 export default defineConfig({
   plugins: [
@@ -102,12 +102,12 @@ export default defineConfig({
 
 ```javascript
 const AutoImport = require("unplugin-auto-import/webpack");
-const { ElementPlusResolver } = require("@ivu-plus/i-utils/resolver");
+const { IUtilsResolver } = require("@ivujs/i-utils/resolver");
 
 module.exports = {
   plugins: [
     AutoImport({
-      resolvers: [ElementPlusResolver()],
+      resolvers: [IUtilsResolver()],
     }),
   ],
 };
@@ -149,35 +149,33 @@ npm publish
 
 [常量集合 Constant](https://github.com/qq575792372/i-utils/blob/main/doc/constants.md)
 
-[字符串](https://github.com/qq575792372/i-utils/blob/main/doc/string.md)  
-[数字](https://github.com/qq575792372/i-utils/blob/main/doc/number.md)  
-[数组](https://github.com/qq575792372/i-utils/blob/main/doc/array.md)  
-[对象](https://github.com/qq575792372/i-utils/blob/main/doc/object.md)  
-[函数](https://github.com/qq575792372/i-utils/blob/main/doc/function.md)  
-[日期](https://github.com/qq575792372/i-utils/blob/main/doc/date.md)  
-[数学](https://github.com/qq575792372/i-utils/blob/main/doc/math.md)  
-[正则](https://github.com/qq575792372/i-utils/blob/main/doc/regexp.md)  
-[随机数](https://github.com/qq575792372/i-utils/blob/main/doc/random.md)
-
-[文件](https://github.com/qq575792372/i-utils/blob/main/doc/file.md)  
-[颜色](https://github.com/qq575792372/i-utils/blob/main/doc/color.md)  
-[校验](https://github.com/qq575792372/i-utils/blob/main/doc/validate.md)  
-[键盘](https://github.com/qq575792372/i-utils/blob/main/doc/keycode.md)
-
-[生成id](https://github.com/qq575792372/i-utils/blob/main/doc/id.md)  
-[加解密算法](https://github.com/qq575792372/i-utils/blob/main/doc/crypto.md)  
-[脱敏](https://github.com/qq575792372/i-utils/blob/main/doc/desensitized.md)  
-[身份证号码](https://github.com/qq575792372/i-utils/blob/main/doc/ID-card.md)  
-[分页](https://github.com/qq575792372/i-utils/blob/main/pagination/net.md)
-
-[浏览器 Url](https://github.com/qq575792372/i-utils/blob/main/doc/browser-url.md)  
-[浏览器 Cookie](https://github.com/qq575792372/i-utils/blob/main/doc/browser-storage.md)  
-[浏览器 Storage](https://github.com/qq575792372/i-utils/blob/main/doc/browser-cookie.md)  
-[浏览器 Dom](https://github.com/qq575792372/i-utils/blob/main/doc/browser-dom.md)  
-[浏览器 Device](https://github.com/qq575792372/i-utils/blob/main/doc/browser-device.md)  
-[浏览器 Clipboard](https://github.com/qq575792372/i-utils/blob/main/doc/browser-clipboard.md)
-
-[微信小程序工具](https://github.com/qq575792372/i-utils/blob/main/doc/weapp.md)
+[字符串](https://github.com/qq575792372/i-utils/blob/main/docs/字符串.md)  
+[数字](https://github.com/qq575792372/i-utils/blob/main/docs/数字.md)  
+[数组](https://github.com/qq575792372/i-utils/blob/main/docs/数组.md)  
+[对象](https://github.com/qq575792372/i-utils/blob/main/docs/对象.md)  
+[函数](https://github.com/qq575792372/i-utils/blob/main/docs/函数.md)  
+[日期](https://github.com/qq575792372/i-utils/blob/main/docs/日期.md)  
+[数学](https://github.com/qq575792372/i-utils/blob/main/docs/数学.md)  
+[正则](https://github.com/qq575792372/i-utils/blob/main/docs/正则.md)  
+[随机数](https://github.com/qq575792372/i-utils/blob/main/docs/随机数.md)
+
+[文件](https://github.com/qq575792372/i-utils/blob/main/docs/文件.md)  
+[颜色](https://github.com/qq575792372/i-utils/blob/main/docs/颜色.md)  
+[校验](https://github.com/qq575792372/i-utils/blob/main/docs/校验.md)  
+[键盘](https://github.com/qq575792372/i-utils/blob/main/docs/键盘.md)
+
+[生成 Id](https://github.com/qq575792372/i-utils/blob/main/docs/生成Id.md)  
+[加解密算法](https://github.com/qq575792372/i-utils/blob/main/docs/加解密算法.md)  
+[脱敏](https://github.com/qq575792372/i-utils/blob/main/docs/脱敏.md)  
+[身份证号码](https://github.com/qq575792372/i-utils/blob/main/docs/身份证号码.md)  
+[分页](https://github.com/qq575792372/i-utils/blob/main/pagination/分页.md)
+
+[浏览器 Url](https://github.com/qq575792372/i-utils/blob/main/docs/浏览器Url.md)  
+[浏览器 Cookie](https://github.com/qq575792372/i-utils/blob/main/docs/浏览器Cookie.md)  
+[浏览器 Storage](https://github.com/qq575792372/i-utils/blob/main/docs/浏览器Storage.md)  
+[浏览器 Dom](https://github.com/qq575792372/i-utils/blob/main/docs/浏览器Dom.md)  
+[浏览器 Device](https://github.com/qq575792372/i-utils/blob/main/docs/浏览器Device.md)  
+[浏览器 Clipboard](https://github.com/qq575792372/i-utils/blob/main/docs/浏览器Clipboard.md)
 
 ### 🔖Git 提交规范
 

package/dist/cjs/ID-card/index.cjs

@@ -4,10 +4,13 @@ var index = require('../validate/index.cjs');
 var index$1 = require('../date/index.cjs');
 var idCard = require('../constants/id-card.cjs');
 
+/**
+ * @module 身份证号码
+ */
 /**
  * 根据身份证号码获取信息
  * @description 能获取到 籍贯，出生日期，年龄，性别
- * @param {String} idCard 身份证号码，支持一代15位和二代18位
+ * @param {string} idCard 身份证号码，支持一代15位和二代18位
  * @returns {Object} 返回身份证信息对象
  */
 function getInfoByIDCard(idCard) {
@@ -26,8 +29,8 @@ function getInfoByIDCard(idCard) {
 }
 /**
  * 根据身份证号码获得生日
- * @param {String} idCard 身份证号码，支持一代15位和二代18位
- * @returns {String} 返回生日
+ * @param {string} idCard 身份证号码，支持一代15位和二代18位
+ * @returns {string} 返回生日
  */
 function getBirthdayByIDCard(idCard) {
     if (index.isNull(idCard))
@@ -43,23 +46,25 @@ function getBirthdayByIDCard(idCard) {
 }
 /**
  * 根据身份证号码获得年龄
- * @param {String} idCard 身份证号码，支持一代15位和二代18位
- * @returns {Number} 返回年龄
+ * @param {string} idCard 身份证号码，支持一代15位和二代18位
+ * @returns {number} 返回年龄
  */
 function getAgeByIDCard(idCard) {
     if (index.isNull(idCard))
         return;
-    let birthday = getBirthdayByIDCard(idCard);
-    return index$1.getAge(index$1.parseDate(birthday));
+    const birthday = getBirthdayByIDCard(idCard);
+    if (birthday) {
+        return index$1.getAge(index$1.toDate(String(birthday)));
+    }
 }
 /**
  * 根据身份证号码获得性别
- * @param {String} idCard 身份证号码，支持一代15位和二代18位
- * @returns {String} 返回性别
+ * @param {string} idCard 身份证号码，支持一代15位和二代18位
+ * @returns {string} 返回性别
  */
 function getSexByIDCard(idCard$1) {
     if (index.isNull(idCard$1))
-        return;
+        return undefined;
     // 15位身份证
     if (idCard$1.length === 15) {
         return Number(idCard$1.substring(14)) % 2 === 0 ? idCard.ID_CARD.SEX.WOMAN : idCard.ID_CARD.SEX.MAN;
@@ -71,13 +76,16 @@ function getSexByIDCard(idCard$1) {
 }
 /**
  * 根据身份证号码获得省份
- * @param {String} idCard 身份证号码，支持一代15位和二代18位
- * @returns {String} 返回省份
+ * @param {string} idCard 身份证号码，支持一代15位和二代18位
+ * @returns {string} 返回省份
  */
 function getProvinceByIDCard(idCard$1) {
     if (index.isNull(idCard$1))
         return;
-    return idCard.ID_CARD.PROVINCE[idCard$1.substring(0, 2)];
+    const prefix = idCard$1.substring(0, 2);
+    if (prefix) {
+        return idCard.ID_CARD.PROVINCE[prefix];
+    }
 }
 
 exports.getAgeByIDCard = getAgeByIDCard;

package/dist/cjs/array/index.cjs

@@ -3,19 +3,22 @@
 var sort = require('../constants/sort.cjs');
 var index = require('../validate/index.cjs');
 
+/**
+ * @module 数组
+ */
 /* 数组计算 */
 /**
  * 数组最小值
  * @param {Array} array 数组
- * @returns {Number} 返回最小值
+ * @returns {number} 返回最小值
  */
 function arrayMin(array) {
     return Math.min.apply(null, array);
 }
 /**
  * 数组最大值
- * @param {Array} array 数组
- * @returns {Number} 返回最大值
+ * @param {array} array 数组
+ * @returns {number} 返回最大值
  */
 function arrayMax(array) {
     return Math.max.apply(null, array);
@@ -23,7 +26,7 @@ function arrayMax(array) {
 /**
  * 数组求和
  * @param {Array} array 数组
- * @returns {Number} 返回和
+ * @returns {number} 返回和
  */
 function arraySum(array) {
     return array.reduce(function (pre, cur) {
@@ -33,7 +36,7 @@ function arraySum(array) {
 /**
  * 数组求平均值
  * @param {Array} array 数组
- * @returns {Number} 返回平均数
+ * @returns {number} 返回平均数
  */
 function arrayAvg(array) {
     return arraySum(array) / array.length;
@@ -41,9 +44,9 @@ function arrayAvg(array) {
 /* 数组比较 */
 /**
  * 数组中是否包含指定的元素
- * @param {String|Number} value 元素
+ * @param {string|number} value 元素
  * @param {Array} array 查找的数组
- * @returns {Boolean} 返回结果
+ * @returns {boolean} 返回结果
  */
 function inArray(value, array) {
     if (index.isNull(value))
@@ -54,7 +57,7 @@ function inArray(value, array) {
  * 比较两个数组是否相等
  * @param {Array} array1 数组1
  * @param {Array} array2 数组2
- * @returns {Boolean} 返回结果
+ * @returns {boolean} 返回结果
  */
 function arrayEquals(array1, array2) {
     if (array1 === array2)
@@ -66,7 +69,7 @@ function arrayEquals(array1, array2) {
 /* 数组操作 */
 /**
  * 生成指定长度的数组
- * @param {Number} length 长度，默认 0
+ * @param {number} length 长度，默认 0
  * @returns {Array} 返回数组
  */
 function arrayCreate(length = 0) {
@@ -76,7 +79,7 @@ function arrayCreate(length = 0) {
  * 数组指定位置添加元素
  * @description 如果数组为空，则在0位置添加元素
  * @param {Array} array 数组
- * @param {Number} index 下标位置，默认0
+ * @param {number} index 下标位置，默认0
  * @param {*} value 添加的元素
  * @returns {Array} 返回操作后的数组
  */
@@ -98,7 +101,7 @@ function arrayInsert(array = [], index = 0, value = undefined) {
  * 数组指定位置前面添加元素
  * @description 如果数组为空，则在0位置添加元素
  * @param {Array} array 数组
- * @param {Number} index 下标位置，默认0
+ * @param {number} index 下标位置，默认0
  * @param {*} value 添加的元素
  * @returns {Array} 返回操作后的数组
  */
@@ -120,7 +123,7 @@ function arrayInsertBefore(array = [], index = 0, value = undefined) {
  * 数组指定位置后面添加元素
  * @description 如果数组为空，则在0位置添加元素
  * @param {Array} array 数组
- * @param {Number} index 下标位置，默认0
+ * @param {number} index 下标位置，默认0
  * @param {*} value 添加的元素
  * @returns {Array} 返回操作后的数组
  */
@@ -141,7 +144,7 @@ function arrayInsertAfter(array = [], index = 0, value = undefined) {
 /**
  * 数组指定位置删除元素
  * @param {Array} array 数组
- * @param {Number} index 下标位置，默认0
+ * @param {number} index 下标位置，默认0
  * @returns {Array} 返回操作后的数组
  */
 function arrayRemove(array = [], index = 0) {
@@ -153,7 +156,7 @@ function arrayRemove(array = [], index = 0) {
 /**
  * 数组指定位置前面删除元素
  * @param {Array} array 数组
- * @param {Number} index 下标位置，默认0
+ * @param {number} index 下标位置，默认0
  * @returns {Array} 返回操作后的数组
  */
 function arrayRemoveBefore(array = [], index = 0) {
@@ -165,7 +168,7 @@ function arrayRemoveBefore(array = [], index = 0) {
 /**
  * 数组指定位置后面删除元素
  * @param {Array} array 数组
- * @param {Number} index 下标位置，默认0
+ * @param {number} index 下标位置，默认0
  * @returns {Array} 返回操作后的数组
  */
 function arrayRemoveAfter(array = [], index = 0) {
@@ -177,7 +180,7 @@ function arrayRemoveAfter(array = [], index = 0) {
 /**
  * 数组置顶
  * @param {Array} array 数组
- * @param {Number} index 下标位置，默认0
+ * @param {number} index 下标位置，默认0
  * @returns {Array} 返回操作后的数组
  */
 function arrayTop(array = [], index = 0) {
@@ -189,7 +192,7 @@ function arrayTop(array = [], index = 0) {
 /**
  * 数组置尾
  * @param {Array} array 数组
- * @param {Number} index 下标位置，默认0
+ * @param {number} index 下标位置，默认0
  * @returns {Array} 返回操作后的数组
  */
 function arrayBottom(array = [], index = 0) {
@@ -201,7 +204,7 @@ function arrayBottom(array = [], index = 0) {
 /**
  * 数组向上移动
  * @param {Array} array 数组
- * @param {Number} index 下标位置，默认0
+ * @param {number} index 下标位置，默认0
  * @returns {Array} 返回操作后的数组
  */
 function arrayUp(array = [], index = 0) {
@@ -218,7 +221,7 @@ function arrayUp(array = [], index = 0) {
 /**
  * 数组向下移动
  * @param {Array} array 数组
- * @param {Number} index 下标位置，默认0
+ * @param {number} index 下标位置，默认0
  * @returns {Array} 返回操作后的数组
  */
 function arrayDown(array = [], index = 0) {
@@ -235,8 +238,8 @@ function arrayDown(array = [], index = 0) {
 /**
  * 数组交换元素
  * @param {Array} array 数组
- * @param {Number} sourceIndex 原索引
- * @param {Number} targetIndex 目标索引
+ * @param {number} sourceIndex 原索引
+ * @param {number} targetIndex 目标索引
  * @returns {Array} 返回操作后的数组
  */
 function arraySwap(array, sourceIndex, targetIndex) {
@@ -249,7 +252,7 @@ function arraySwap(array, sourceIndex, targetIndex) {
 /**
  * 数组排序
  * @param {Array} array 数组
- * @param {Number} mode 排序模式，参考常量集合中 数组常量，默认是升序
+ * @param {number} mode 排序模式，参考常量集合中 数组常量，默认是升序
  * @returns {Array} 返回操作后的数组
  */
 function arraySort(array, mode = sort.SORT.ASC) {
@@ -264,9 +267,8 @@ function arraySort(array, mode = sort.SORT.ASC) {
             // 随机
             case sort.SORT.RANDOM:
                 return Math.random() - 0.5;
-            // 默认
             default:
-                return array;
+                return 0;
         }
     });
 }
@@ -279,7 +281,7 @@ function arraySort(array, mode = sort.SORT.ASC) {
  */
 function arraySortBy(array, props) {
     return array.sort((a, b) => {
-        for (let item of props) {
+        for (const item of props) {
             // 排序配置
             let prop = "", order = "asc";
             if (index.isObject(item)) {
@@ -332,8 +334,12 @@ function arrayShuffle(array) {
  * @param {Object} setting 配置项
  * @returns {Array} 返回树形节点
  */
-function arrayToTree(array, setting = { key: "id", parentKey: "pid", childrenKey: "children" }) {
-    let key = setting.key, parentKey = setting.parentKey, childrenKey = setting.childrenKey;
+function arrayToTree(array, setting = {
+    key: "id",
+    parentKey: "pid",
+    childrenKey: "children",
+}) {
+    const key = setting.key, parentKey = setting.parentKey, childrenKey = setting.childrenKey;
     // 数组或者key是否为空
     if (!array || array.length === 0 || !key || key === "")
         return [];
@@ -348,15 +354,15 @@ function arrayToTree(array, setting = { key: "id", parentKey: "pid", childrenKey
         return node[childrenKey];
     };
     // 声明变量
-    let result = [];
-    let tempMap = {};
+    const result = [];
+    const tempMap = {};
     for (let i = 0; i < array.length; i++) {
         // 如果源数据数组中有children，则需要删除掉，否则会导致和之前的children合并
         array[i][childrenKey] && delete array[i][childrenKey];
         tempMap[array[i][key]] = array[i];
     }
     for (let i = 0; i < array.length; i++) {
-        let parent = tempMap[array[i][parentKey]];
+        const parent = tempMap[array[i][parentKey]];
         if (parent && array[i][key] !== array[i][parentKey]) {
             let children = nodeChildren(parent, childrenKey);
             if (!children) {
@@ -378,9 +384,9 @@ function arrayToTree(array, setting = { key: "id", parentKey: "pid", childrenKey
  * @returns {Array} 返回普通数组
  */
 function treeToArray(nodes, setting = { childrenKey: "children" }) {
-    let childrenKey = setting.childrenKey;
-    let result = [];
-    for (let node of nodes) {
+    const childrenKey = setting.childrenKey;
+    const result = [];
+    for (const node of nodes) {
         // 删除掉多余空的children
         if (node[childrenKey] && !node[childrenKey].length) {
             delete node[childrenKey];
@@ -388,7 +394,7 @@ function treeToArray(nodes, setting = { childrenKey: "children" }) {
         result.push(node);
         // 继续执行
         if (node[childrenKey] && node[childrenKey].length) {
-            let array = treeToArray(node[childrenKey], setting);
+            const array = treeToArray(node[childrenKey], setting);
             array && result.push(...array);
         }
     }

package/dist/cjs/clipboard/index.cjs

@@ -2,6 +2,9 @@
 
 var index = require('../file/index.cjs');
 
+/**
+ * @module 浏览器Clipboard
+ */
 /**
  * 获得剪切板数据
  * @description 获得的剪切板的数据是会返回多个可用的MIME类型，比如是纯文本就返回一个['text/plain']，是复制的html则会返回两个可用的['text/plain','text/html']，是复制的图片则是['image/png']
@@ -11,13 +14,13 @@ function getClipboard() {
     return new Promise((resolve, reject) => {
         if (window.navigator.clipboard) {
             window.navigator.clipboard.read().then((clipboardItems) => {
-                let list = [];
-                for (let item of clipboardItems) {
-                    for (let type of item.types) {
+                const list = [];
+                for (const item of clipboardItems) {
+                    for (const type of item.types) {
                         item.getType(type).then(async (blob) => {
                             // 文本类型，可以直接输出为字符串
                             if (blob.type.includes("text")) {
-                                let text = await index.blobToText(blob);
+                                const text = await index.blobToText(blob);
                                 list.push({ type: blob.type, data: text });
                             }
                             // 图片和其他文件类型，返回blob对象
@@ -59,7 +62,7 @@ function getClipboardText() {
 /**
  * 设置剪切板数据
  * @description 可以设置文本或者blob类型的数据
- * @param {String,Blob} data 写入的数据，可以是文本或blob数据
+ * @param {string|Blob} data 写入的数据，可以是文本或blob数据
  * @returns {Promise} 返回结果
  */
 function setClipboard(data) {
@@ -69,7 +72,7 @@ function setClipboard(data) {
             let clipboardItem = null;
             // 是文本类型
             if (typeof data === "string") {
-                let blob = new Blob([data], { type: "text/plain" });
+                const blob = new Blob([data], { type: "text/plain" });
                 clipboardItem = new window.ClipboardItem({
                     ["text/plain"]: blob,
                 });
@@ -92,7 +95,7 @@ function setClipboard(data) {
 }
 /**
  * 设置剪切板文本
- * @param {String} text 写入的文本
+ * @param {string} text 写入的文本
  * @returns {Promise} 返回结果
  */
 function setClipboardText(text) {
@@ -115,9 +118,10 @@ function setClipboardText(text) {
  * @returns {Promise} 返回结果
  */
 function clearClipboard() {
-    return new Promise(async (resolve, reject) => {
-        await setClipboardText("");
-        resolve(true);
+    return new Promise((resolve, reject) => {
+        setClipboardText("")
+            .then(() => resolve(true))
+            .catch(reject);
     });
 }