util-helpers 4.17.2 → 4.18.0

package/lib/round.js

@@ -1,14 +1,14 @@
 'use strict';
 
+var ut2 = require('ut2');
 var divide = require('./divide.js');
 var times = require('./times.js');
 var math_util = require('./utils/math.util.js');
-var isNaN = require('./utils/type/isNaN.js');
 
 function round(num, precision) {
     if (precision === void 0) { precision = 0; }
     num = math_util.transformEffectiveNumber(num);
-    if (isNaN(num)) {
+    if (ut2.isNaN(num)) {
         return Number.NaN;
     }
     var base = Math.pow(10, precision);

package/lib/strlen.js

@@ -1,9 +1,9 @@
 'use strict';
 
-var normalizeString = require('./normalizeString.js');
+var ut2 = require('ut2');
 
 function strlen(str) {
-    var realStr = normalizeString(str);
+    var realStr = ut2.toString(str);
     var len = 0;
     for (var i = 0; i < realStr.length; i++) {
         var c = realStr.charCodeAt(i);

package/lib/times.js

@@ -1,8 +1,8 @@
 'use strict';
 
 var tslib = require('tslib');
+var ut2 = require('ut2');
 var math_util = require('./utils/math.util.js');
-var isNaN = require('./utils/type/isNaN.js');
 
 function times() {
     var nums = [];
@@ -15,7 +15,7 @@ function times() {
     }
     num1 = math_util.transformEffectiveNumber(num1);
     num2 = math_util.transformEffectiveNumber(num2);
-    if (isNaN(num1) || isNaN(num2)) {
+    if (ut2.isNaN(num1) || ut2.isNaN(num2)) {
         return Number.NaN;
     }
     var num1Changed = math_util.float2Fixed(num1);

package/lib/transformFieldNames.js

@@ -1,7 +1,7 @@
 'use strict';
 
 var tslib = require('tslib');
-var isObject = require('./utils/type/isObject.js');
+var ut2 = require('ut2');
 
 function transformFieldNames(data, fieldNames, childrenField, nodeAssign) {
     if (nodeAssign === void 0) { nodeAssign = 'spread'; }
@@ -13,7 +13,7 @@ function transformFieldNames(data, fieldNames, childrenField, nodeAssign) {
     }
     function recusion(arr) {
         return arr.map(function (item) {
-            if (!isObject(item)) {
+            if (!ut2.isObject(item)) {
                 return item;
             }
             var newItem = nodeAssign === 'spread' ? tslib.__assign({}, item) : item;

package/lib/treeToList.js

@@ -1,7 +1,7 @@
 'use strict';
 
 var tslib = require('tslib');
-var isObject = require('./utils/type/isObject.js');
+var ut2 = require('ut2');
 
 function treeToList(tree, childrenField) {
     var list = [];
@@ -10,7 +10,7 @@ function treeToList(tree, childrenField) {
     }
     function recusion(arr) {
         arr.forEach(function (item) {
-            if (isObject(item)) {
+            if (ut2.isObject(item)) {
                 var newItem = tslib.__assign({}, item);
                 list.push(newItem);
                 if (newItem[childrenField]) {

package/lib/utils/config.js

@@ -6,6 +6,5 @@ exports.config = {
 function setDisableWarning(bool) {
     exports.config.disableWarning = !!bool;
 }
-exports.version = "4.17.2";
 
 exports.setDisableWarning = setDisableWarning;

package/lib/utils/math.util.js

@@ -1,14 +1,11 @@
 'use strict';
 
-var constants = require('./constants.js');
+var ut2 = require('ut2');
 var devWarn = require('./devWarn.js');
-var isNumber = require('./type/isNumber.js');
-var isString = require('./type/isString.js');
-var isSymbol = require('./type/isSymbol.js');
 
 function transformEffectiveNumber(value) {
     var ret;
-    if (isString(value)) {
+    if (ut2.isString(value)) {
         ret = value.trim();
         if (ret === '') {
             ret = Number(ret);
@@ -17,10 +14,10 @@ function transformEffectiveNumber(value) {
             ret = Number.NaN;
         }
     }
-    else if (isSymbol(value)) {
+    else if (ut2.isSymbol(value)) {
         ret = Number.NaN;
     }
-    else if (!isNumber(value)) {
+    else if (!ut2.isNumber(value)) {
         ret = Number(value);
     }
     else {
@@ -52,7 +49,7 @@ function float2Fixed(num) {
     return dLen > 0 ? strip(+num * Math.pow(10, dLen)) : +num;
 }
 function checkBoundary(num) {
-    if (+num > constants.MAX_SAFE_INTEGER || +num < constants.MIN_SAFE_INTEGER) {
+    if (+num > ut2.MAX_SAFE_INTEGER || +num < ut2.MIN_SAFE_INTEGER) {
         devWarn("".concat(num, " is beyond boundary when transfer to integer, the results may not be accurate"));
     }
 }

package/lib/waitTime.js

@@ -1,10 +1,10 @@
 'use strict';
 
+var ut2 = require('ut2');
+
 function waitTime(time) {
     if (time === void 0) { time = 1000; }
-    return new Promise(function (resolve) {
-        setTimeout(resolve, time);
-    });
+    return ut2.sleep(time);
 }
 
 module.exports = waitTime;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "util-helpers",
-  "version": "4.17.2",
+  "version": "4.18.0",
   "description": "一个基于业务场景的工具方法库",
   "main": "lib/index.js",
   "module": "esm/index.js",
@@ -18,12 +18,11 @@
     "build": "npm run build:module && npm run build:dist && npm run build:types",
     "build:module": "rm -rf esm && rm -rf lib && rollup -c rollup.module.config.mjs",
     "build:dist": "rm -rf dist && rollup -c rollup.umd.config.mjs",
-    "build:types": "rm -rf types && tsc -d --outDir types --emitDeclarationOnly",
+    "build:types": "rm -rf types && tsc -p tsconfig.build.json -d --outDir types --emitDeclarationOnly",
     "build:doc": "npm run doc",
-    "doc": "rm -rf docs && rm -rf docs-src && tsc --outDir docs-src && jsdoc -c conf.json && rm -rf docs-src",
+    "doc": "rm -rf docs && rm -rf docs-src && tsc -p tsconfig.build.json --outDir docs-src && jsdoc -c conf.json && rm -rf docs-src",
     "doc:open": "open ./docs/index.html",
     "prettier": "prettier --write 'src/**/*.ts' && prettier --write 'test/**/*.ts'",
-    "precommit": "lint-staged",
     "lint": "eslint src --ext .ts",
     "lint:fix": "eslint src --ext .ts --fix",
     "commit": "cz",
@@ -55,42 +54,41 @@
   },
   "homepage": "https://doly-dev.github.io/util-helpers/index.html",
   "devDependencies": {
-    "@babel/core": "^7.21.4",
-    "@babel/preset-env": "^7.21.4",
-    "@babel/preset-typescript": "^7.21.4",
-    "@commitlint/cli": "^11.0.0",
-    "@commitlint/config-conventional": "^11.0.0",
+    "@babel/core": "^7.21.8",
+    "@babel/preset-env": "^7.21.5",
+    "@babel/preset-typescript": "^7.21.5",
+    "@commitlint/cli": "^17.6.3",
+    "@commitlint/config-conventional": "^17.6.3",
     "@rollup/plugin-commonjs": "^24.1.0",
     "@rollup/plugin-node-resolve": "^15.0.2",
     "@rollup/plugin-replace": "^5.0.2",
     "@rollup/plugin-terser": "^0.4.1",
     "@rollup/plugin-typescript": "^11.1.0",
     "@types/jest": "^29.5.1",
-    "@typescript-eslint/eslint-plugin": "^5.59.1",
-    "@typescript-eslint/parser": "^5.59.1",
+    "@typescript-eslint/eslint-plugin": "^5.59.5",
+    "@typescript-eslint/parser": "^5.59.5",
     "babel-jest": "^29.5.0",
     "babel-plugin-minify-replace": "^0.5.0",
     "cross-env": "^7.0.3",
     "cz-conventional-changelog": "^3.3.0",
-    "docdash": "^1.2.0",
-    "eslint": "^8.39.0",
-    "husky": "^4.3.6",
+    "docdash": "^2.0.1",
+    "eslint": "^8.40.0",
     "jest": "^29.5.0",
     "jest-environment-jsdom": "^29.5.0",
-    "jsdoc": "^3.6.3",
-    "lint-staged": "^11.1.2",
+    "jsdoc": "^4.0.2",
+    "lint-staged": "^13.2.2",
     "prettier": "^2.8.8",
-    "rollup": "^3.21.0",
-    "typescript": "^5.0.4"
+    "rollup": "^3.21.6",
+    "typescript": "^5.0.4",
+    "yorkie": "^2.0.0"
   },
   "lint-staged": {
     "**/*.ts": "eslint",
     "**/*.{js,ts,md}": "prettier --write"
   },
-  "husky": {
-    "hooks": {
-      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
-    }
+  "gitHooks": {
+    "pre-commit": "lint-staged",
+    "commit-msg": "npx --no -- commitlint --edit \"$1\""
   },
   "config": {
     "commitizen": {
@@ -98,6 +96,7 @@
     }
   },
   "dependencies": {
-    "tslib": "^2.5.0"
+    "tslib": "^2.5.0",
+    "ut2": "^1.0.0"
   }
 }

package/types/VERSION.d.ts

@@ -0,0 +1,8 @@
+/**
+ * util-helpers 版本号
+ *
+ * @static
+ * @since 4.18.0
+ */
+declare const VERSION: string;
+export default VERSION;

package/types/ajax.d.ts

@@ -40,7 +40,7 @@ type AjaxOptions = {
  * @property {function} [onLoadEnd] 请求结束时触发，无论请求成功 (load) 还是失败 (abort 或 error)
  */
 /**
- * 请求<br/><br/>
+ * 请求
  *
  * <em style="font-weight: bold;">注意：该方法仅适用于浏览器端。</em>
  *

package/types/blobToDataURL.d.ts

@@ -1,5 +1,5 @@
 /**
- * 将 Blob 或 File 对象转成 data:URL 格式的 Base64 字符串<br/><br/>
+ * 将 Blob 或 File 对象转成 data:URL 格式的 Base64 字符串
  *
  * <em style="font-weight: bold;">注意：该方法仅适用于浏览器端。</em>
  *

package/types/calculateCursorPosition.d.ts

@@ -1,5 +1,5 @@
 type CalculateCursorPositionOptions = {
-    placeholderChar?: string;
+    placeholderChar?: string | string[];
     maskReg?: RegExp;
     type?: 'mobile' | 'bankCard';
 };

package/types/download.d.ts

@@ -29,7 +29,7 @@ type DownloadOptions = {
  * @property {TransformResponse} [options.transformResponse] 请求成功后触发，在传递给 then/catch 前，允许修改响应数据
  */
 /**
- * 下载<br/><br/>
+ * 下载
  *
  * <em style="font-weight: bold;">注意：该方法仅适用于浏览器端，兼容 IE10+ 和现代浏览器。</em>
  *
@@ -45,8 +45,12 @@ type DownloadOptions = {
  * // 文本
  * download('hello world', 'text.txt');
  *
- * // 远程文件
- * download('/xxx.jpg', { dataType: 'url' });
+ * // 远程文件1
+ * // 不带协议的绝对地址，需要通过 dataType 指定为 url 类型
+ * download('/xxx.jpg', { dataType: 'url', fileName: 'test.jpg' });
+ *
+ * // 远程文件2
+ * download('https://example.com/xxx.jpg');
  *
  * // base64
  * download('data:image/png;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=', 'test.png');

package/types/filterTree.d.ts

@@ -1,6 +1,8 @@
 type NodeAssign = 'spread' | 'self';
 /**
- * 过滤/筛选树节点。<br/><br/>如果某节点被过滤掉，它的子节点也一并抛弃
+ * 过滤/筛选树节点。
+ *
+ * 如果某节点被过滤掉，它的子节点也一并抛弃。
  *
  * @static
  * @alias module:Tree.filterTree

package/types/formatBankCard.d.ts

@@ -30,5 +30,5 @@ type Options = {
  * formatBankCard('6228480402564890', {spaceMark: '-'}); // 6228-4804-0256-4890
  *
  */
-declare function formatBankCard(bankCardNo?: string, options?: Options): string;
+declare function formatBankCard(bankCardNo?: string, options?: Options): any;
 export default formatBankCard;

package/types/formatMobile.d.ts

@@ -28,5 +28,5 @@ type Options = {
  * formatMobile('13345678'); // 133 4567 8
  *
  */
-declare function formatMobile(mobileNo?: string, options?: Options): string;
+declare function formatMobile(mobileNo?: string, options?: Options): any;
 export default formatMobile;

package/types/index.d.ts

@@ -123,4 +123,10 @@ export { default as findTreeSelect } from './findTreeSelect';
  * @ignore
  * @since 3.6.1
  */
-export { setDisableWarning, version } from './utils/config';
+export { setDisableWarning } from './utils/config';
+import VERSION from './VERSION';
+export { VERSION };
+/**
+ * @deprecated 即将废弃，请使用 `VERSION`
+ */
+export declare const version: string;

package/types/isIdCard.d.ts

@@ -3,7 +3,9 @@ type Options = {
     checkCode?: boolean;
 };
 /**
- * 检测值是否为18位身份证号码。<br/>宽松模式下，支持15位身份证号码
+ * 检测值是否为18位身份证号码。
+ *
+ * 宽松模式下，支持15位身份证号码。
  *
  * @static
  * @alias module:Validator.isIdCard

package/types/isPromiseLike.d.ts

@@ -4,6 +4,7 @@
  * @static
  * @alias module:Validator.isPromiseLike
  * @since 3.8.0
+ * @deprecated 即将废弃，请使用 `import { isPromiseLike } 'ut2'`
  * @param {*} obj 要检测的值
  * @returns {boolean} 是否类似Promise对象
  * @example

package/types/normalizeString.d.ts

@@ -5,6 +5,7 @@
  * @alias module:Processor.normalizeString
  * @since 4.3.0
  * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/String#string_instances | String}
+ * @deprecated 即将废弃，请使用 `import { toString } 'ut2'`
  * @param {*} value 待处理的值
  * @returns {string} 规整化的值
  * @example
@@ -20,5 +21,5 @@
  * normalizeString('a'); // 'a'
  *
  */
-declare function normalizeString(value: any): string;
+declare function normalizeString(value: any): any;
 export default normalizeString;

package/types/numberToChinese.d.ts

@@ -10,7 +10,7 @@ type Options = {
     };
 };
 /**
- * 数字转中文数字<br/><br/>
+ * 数字转中文数字
  *
  * 如果数字不在安全数字 -9007199254740991～9007199254740991 范围内，处理会有异常。
  *

package/types/padZero.d.ts

@@ -21,5 +21,5 @@
  * padZero('688', 5); // 00688
  *
  */
-declare function padZero(value: string | number, size?: number): string;
+declare function padZero(value: string | number, size?: number): any;
 export default padZero;

package/types/replaceChar.d.ts

@@ -24,6 +24,9 @@ type Options = {
  * // 手机号 前3后4
  * replaceChar('13000000000'); // 130****0000
  *
+ * // 手机号 前2后4
+ * replaceChar('13000000000', { start: 2 }); // 13*****0000
+ *
  * // 身份证 前6后4
  * replaceChar('130701199310302288', { start: 6, end: -4 }); // 130701********2288
  *
@@ -50,5 +53,5 @@ type Options = {
  * replaceChar('林某某某', {start: 1, end: Infinity, repeat: 2}); // 林**
  *
  */
-declare function replaceChar(str: string, options?: Options): string;
+declare function replaceChar(str: string, options?: Options): any;
 export default replaceChar;

package/types/setDataURLPrefix.d.ts

@@ -1,5 +1,6 @@
 /**
- * 设置 DataURL 前缀、MIME 类型、base64 标识。<br/>
+ * 设置 DataURL 前缀、MIME 类型、base64 标识。
+ *
  * 如果你需要获取DataURL 的 MIME 类型和数据本身，推荐使用 <a href="https://www.npmjs.com/package/data-urls">data-urls</a>。
  *
  * @static

package/types/treeToList.d.ts

@@ -4,12 +4,9 @@
  * @static
  * @alias module:Tree.treeToList
  * @since 4.14.0
- * @template {Record<string,any>} T
- * @template {keyof T} K
- * @template {Omit<T, K>} R
- * @param {T[]} tree 列表数据
- * @param {K} childrenField 子级字段名称
- * @returns {R[]} 列表数据
+ * @param {object[]} tree 树结构数据
+ * @param {string} childrenField 子级字段名称
+ * @returns {object[]} 列表数据
  * @example
  * const menus = [{ "id": "1", "name": "首页", "code": "trade", "pid": null }, { "id": "2", "name": "交易管理", "code": "trade", "pid": null, "children": [{ "id": "3", "name": "交易查询", "code": "trade-1", "pid": "2", "children": [{ "id": "4", "name": "交易查询-查询操作", "code": "trade-1-1", "pid": "3" }] }] }, { "id": "5", "name": "权限管理", "code": "authorization", "pid": null, "children": [{ "id": "6", "name": "角色管理", "code": "authorization-1", "pid": "5" }, { "id": "7", "name": "用户管理", "code": "authorization-2", "pid": "5" }] }];
  *

package/types/utils/config.d.ts

@@ -9,5 +9,4 @@ declare const config: {
  * @param {boolean} bool 是否禁止warning提示
  */
 declare function setDisableWarning(bool: boolean): void;
-declare const version: string;
-export { config, setDisableWarning, version };
+export { config, setDisableWarning };

package/types/waitTime.d.ts

@@ -4,6 +4,7 @@
  * @static
  * @alias module:Other.waitTime
  * @since 4.2.0
+ * @deprecated 即将废弃，请使用 `import { sleep } from 'ut2'`
  * @param {number} [time=1000] 延时时间，单位毫秒
  * @returns {Promise<void>}
  * @example
@@ -18,5 +19,5 @@
  * });
  *
  */
-declare function waitTime(time?: number): Promise<unknown>;
+declare function waitTime(time?: number): Promise<void>;
 export default waitTime;

package/esm/utils/constants.js

@@ -1,4 +0,0 @@
-var MAX_SAFE_INTEGER = Number.MAX_SAFE_INTEGER || 9007199254740991;
-var MIN_SAFE_INTEGER = Number.MIN_SAFE_INTEGER || -9007199254740991;
-
-export { MAX_SAFE_INTEGER, MIN_SAFE_INTEGER };

package/esm/utils/convertToString.js

@@ -1,7 +0,0 @@
-import isString from './type/isString.js';
-
-function convertToString(value) {
-    return isString(value) ? value : String(value);
-}
-
-export { convertToString as default };

package/esm/utils/type/isBlob.js

@@ -1,7 +0,0 @@
-import isType from './isType.js';
-
-function isBlob(value) {
-    return isType(value, 'Blob');
-}
-
-export { isBlob as default };

package/esm/utils/type/isNaN.js

@@ -1,7 +0,0 @@
-import isType from './isType.js';
-
-function _isNaN(value) {
-    return isType(value, 'Number') && isNaN(value);
-}
-
-export { _isNaN as default };

package/esm/utils/type/isNil.js

@@ -1,8 +0,0 @@
-import isUndefined from './isUndefined.js';
-import isNull from './isNull.js';
-
-function isNil(value) {
-    return isUndefined(value) || isNull(value);
-}
-
-export { isNil as default };

package/esm/utils/type/isNull.js

@@ -1,5 +0,0 @@
-function isNull(value) {
-    return value === null;
-}
-
-export { isNull as default };

package/esm/utils/type/isNumber.js

@@ -1,7 +0,0 @@
-import isType from './isType.js';
-
-function isNumber(value) {
-    return isType(value, 'Number');
-}
-
-export { isNumber as default };

package/esm/utils/type/isObject.js

@@ -1,6 +0,0 @@
-function isObject(value) {
-    var type = typeof value;
-    return value != null && (type === 'object' || type === 'function');
-}
-
-export { isObject as default };

package/esm/utils/type/isString.js

@@ -1,7 +0,0 @@
-import isType from './isType.js';
-
-function isString(value) {
-    return isType(value, 'String');
-}
-
-export { isString as default };

package/esm/utils/type/isSymbol.js

@@ -1,7 +0,0 @@
-import isType from './isType.js';
-
-function isSymbol(value) {
-    return isType(value, 'Symbol');
-}
-
-export { isSymbol as default };

package/esm/utils/type/isType.js

@@ -1,6 +0,0 @@
-var toString = Object.prototype.toString;
-function isType(value, typename) {
-    return toString.call(value) === "[object ".concat(typename, "]");
-}
-
-export { isType as default };

package/esm/utils/type/isUndefined.js

@@ -1,5 +0,0 @@
-function isUndefined(value) {
-    return value === void 0;
-}
-
-export { isUndefined as default };

package/lib/utils/constants.js

@@ -1,4 +0,0 @@
-'use strict';
-
-exports.MAX_SAFE_INTEGER = Number.MAX_SAFE_INTEGER || 9007199254740991;
-exports.MIN_SAFE_INTEGER = Number.MIN_SAFE_INTEGER || -9007199254740991;

package/lib/utils/convertToString.js

@@ -1,9 +0,0 @@
-'use strict';
-
-var isString = require('./type/isString.js');
-
-function convertToString(value) {
-    return isString(value) ? value : String(value);
-}
-
-module.exports = convertToString;

package/lib/utils/type/isBlob.js

@@ -1,9 +0,0 @@
-'use strict';
-
-var isType = require('./isType.js');
-
-function isBlob(value) {
-    return isType(value, 'Blob');
-}
-
-module.exports = isBlob;

package/lib/utils/type/isNaN.js

@@ -1,9 +0,0 @@
-'use strict';
-
-var isType = require('./isType.js');
-
-function _isNaN(value) {
-    return isType(value, 'Number') && isNaN(value);
-}
-
-module.exports = _isNaN;

package/lib/utils/type/isNil.js

@@ -1,10 +0,0 @@
-'use strict';
-
-var isUndefined = require('./isUndefined.js');
-var isNull = require('./isNull.js');
-
-function isNil(value) {
-    return isUndefined(value) || isNull(value);
-}
-
-module.exports = isNil;

package/lib/utils/type/isNull.js

@@ -1,7 +0,0 @@
-'use strict';
-
-function isNull(value) {
-    return value === null;
-}
-
-module.exports = isNull;

package/lib/utils/type/isNumber.js

@@ -1,9 +0,0 @@
-'use strict';
-
-var isType = require('./isType.js');
-
-function isNumber(value) {
-    return isType(value, 'Number');
-}
-
-module.exports = isNumber;

package/lib/utils/type/isObject.js

@@ -1,8 +0,0 @@
-'use strict';
-
-function isObject(value) {
-    var type = typeof value;
-    return value != null && (type === 'object' || type === 'function');
-}
-
-module.exports = isObject;