util-helpers 4.17.1 → 4.17.3

package/esm/index.js

@@ -20,6 +20,7 @@ export { default as isPromiseLike } from './isPromiseLike.js';
 export { default as isHMCard } from './isHMCard.js';
 export { default as isTWCard } from './isTWCard.js';
 export { default as isSwiftCode } from './isSwiftCode.js';
+export { default as isValidNumber } from './isValidNumber.js';
 export { default as formatMoney } from './formatMoney.js';
 export { default as formatBankCard } from './formatBankCard.js';
 export { default as replaceChar } from './replaceChar.js';

package/esm/isValidNumber.js

@@ -0,0 +1,23 @@
+import isSymbol from './utils/type/isSymbol.js';
+
+function isValidNumber(value, strict) {
+    if (strict === void 0) { strict = false; }
+    var ret;
+    if (strict) {
+        ret = typeof value === 'string' && value !== '' ? Number(value) : value;
+    }
+    else {
+        if (typeof value === 'number') {
+            ret = value;
+        }
+        else if (isSymbol(value)) {
+            ret = Number.NaN;
+        }
+        else {
+            ret = Number(value);
+        }
+    }
+    return typeof ret === 'number' && !Number.isNaN(ret);
+}
+
+export { isValidNumber as default };

package/esm/utils/config.js

@@ -4,6 +4,6 @@ var config = {
 function setDisableWarning(bool) {
     config.disableWarning = !!bool;
 }
-var version = "4.17.1";
+var version = "4.17.3";
 
 export { config, setDisableWarning, version };

package/lib/index.js

@@ -22,6 +22,7 @@ var isPromiseLike = require('./isPromiseLike.js');
 var isHMCard = require('./isHMCard.js');
 var isTWCard = require('./isTWCard.js');
 var isSwiftCode = require('./isSwiftCode.js');
+var isValidNumber = require('./isValidNumber.js');
 var formatMoney = require('./formatMoney.js');
 var formatBankCard = require('./formatBankCard.js');
 var replaceChar = require('./replaceChar.js');
@@ -80,6 +81,7 @@ exports.isPromiseLike = isPromiseLike;
 exports.isHMCard = isHMCard;
 exports.isTWCard = isTWCard;
 exports.isSwiftCode = isSwiftCode;
+exports.isValidNumber = isValidNumber;
 exports.formatMoney = formatMoney;
 exports.formatBankCard = formatBankCard;
 exports.replaceChar = replaceChar;

package/lib/isValidNumber.js

@@ -0,0 +1,25 @@
+'use strict';
+
+var isSymbol = require('./utils/type/isSymbol.js');
+
+function isValidNumber(value, strict) {
+    if (strict === void 0) { strict = false; }
+    var ret;
+    if (strict) {
+        ret = typeof value === 'string' && value !== '' ? Number(value) : value;
+    }
+    else {
+        if (typeof value === 'number') {
+            ret = value;
+        }
+        else if (isSymbol(value)) {
+            ret = Number.NaN;
+        }
+        else {
+            ret = Number(value);
+        }
+    }
+    return typeof ret === 'number' && !Number.isNaN(ret);
+}
+
+module.exports = isValidNumber;

package/lib/utils/config.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "util-helpers",
-  "version": "4.17.1",
+  "version": "4.17.3",
   "description": "一个基于业务场景的工具方法库",
   "main": "lib/index.js",
   "module": "esm/index.js",
@@ -10,7 +10,7 @@
   "scripts": {
     "test": "jest --verbose",
     "test:coverage": "jest --coverage",
-    "test:coverage:local": "cross-env COVERAGE_LOCAL=1 jest --coverage",
+    "test:coverage:local": "cross-env COVERAGE_LOCAL=1 jest --coverage && open ./coverage/lcov-report/index.html",
     "test:math": "jest --verbose test/math",
     "test:type": "jest --verbose test/type",
     "test:validator": "jest --verbose test/validator",
@@ -18,16 +18,16 @@
     "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",
-    "prepublishOnly": "npm test && npm run build"
+    "prepublishOnly": "npm test && npm run build",
+    "tsc": "tsc --noEmit"
   },
   "repository": {
     "type": "git",
@@ -54,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": {

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/fileReader.d.ts

@@ -5,32 +5,6 @@ declare const FileReaderMethodMap: {
     readonly text: "readAsText";
 };
 type ReadType = keyof typeof FileReaderMethodMap;
-/**
- * 读取 Blob 或 File 对象，转为 Base64/String/ArrayBuffer<br/><br/>
- *
- * <em style="font-weight: bold;">注意：该方法仅适用于浏览器端。</em>
- *
- * @static
- * @alias module:Processor.fileReader
- * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/API/FileReader | FileReader}
- * @since 4.16.0
- * @param {Blob} blob Blob 或 File 对象
- * @param {'arrayBuffer'|'binaryString'|'dataURL'|'text'} [type='dataURL'] 读取类型
- * @returns {Promise<string|ArrayBuffer>} 文件内容
- * @example
- * const aFileParts = ['<a id="a"><b id="b">hey!</b></a>']; // 一个包含DOMString的数组
- * const htmlBlob = new Blob(aFileParts, { type: 'text/html' }); // 得到 blob
- *
- * fileReader(htmlBlob).then(data=>{
- *   console.log(data); // data:text/html;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=
- * });
- *
- * const textBlob = new Blob(aFileParts, { type: 'text/plain' });
- *
- * fileReader(textBlob, 'text').then(data=>{
- *   console.log(data); // <a id="a"><b id="b">hey!</b></a>
- * });
- */
 declare function fileReader(blob: Blob, type: 'arrayBuffer'): Promise<ArrayBuffer>;
 declare function fileReader(blob: Blob, type?: Exclude<ReadType, 'arrayBuffer'>): Promise<string>;
 export default fileReader;

package/types/filterTree.d.ts

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

package/types/index.d.ts

@@ -26,6 +26,7 @@ export { default as isPromiseLike } from './isPromiseLike';
 export { default as isHMCard } from './isHMCard';
 export { default as isTWCard } from './isTWCard';
 export { default as isSwiftCode } from './isSwiftCode';
+export { default as isValidNumber } from './isValidNumber';
 /**
  * 数据处理
  *

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/isValidNumber.d.ts

@@ -0,0 +1,33 @@
+/**
+ * 检测值是否为有效数值，支持隐式转换。如果返回 true ，表示可以通过 Number() 转为数字。
+ *
+ * @static
+ * @alias module:Validator.isValidNumber
+ * @since 4.17.2
+ * @param {*} value 待检测的值
+ * @param {boolean} [strict=false] 严格模式，如果为 true ，仅支持字符串和数字类型，不处理其他类型隐式转换，且空字符串返回 false 。
+ * @returns {boolean} 值是否为有效数值
+ * @example
+ *
+ * isValidNumber(null); // true
+ * isValidNumber(true); // true
+ * isValidNumber(''); // true
+ * isValidNumber(1234); // true
+ * isValidNumber('1234'); // true
+ * isValidNumber(' 1234 '); // true
+ * isValidNumber(' 1234 '); // true
+ *
+ * isValidNumber(undefined); // false
+ * isValidNumber('0.10.1'); // false
+ *
+ * // 严格模式
+ * isValidNumber(null, true); // false
+ * isValidNumber(true, true); // false
+ * isValidNumber('', true); // false
+ * isValidNumber(1234, true); // true
+ * isValidNumber('1234', true); // true
+ * isValidNumber(' 1234 ', true); // true
+ * isValidNumber(' 1234 ', true); // true
+ */
+declare function isValidNumber(value: any, strict?: boolean): boolean;
+export default isValidNumber;

package/types/numberToChinese.d.ts

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

package/types/safeDate.d.ts

@@ -1,25 +1,3 @@
-/**
- * 创建一个 Date 实例日期对象，同 <a href="https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Date#%E5%8F%82%E6%95%B0">new Date()</a> <br/><br/>
- *
- * 规避了苹果设备浏览器不支持部分格式（例如，YYYY-MM-DD HH-mm 或 YYYY.MM.DD）。<br/>
- * 如果参数为 undefined 正常返回 Date 。
- *
- * @static
- * @alias module:Processor.safeDate
- * @since 4.4.0
- * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/JavaScript/Reference/Global_Objects/Date | Date}
- * @param {string|number|Date} [value] 日期时间字符串、毫秒数、日期对象
- * @param {...number} [args] 月/日/时/分/秒/毫秒
- * @returns {Date} Date 实例日期对象
- * @example
- *
- * safeDate('2022-1-1'); // Sat Jan 01 2022 00:00:00 GMT+0800 (中国标准时间)
- * safeDate('2022/1/1'); // Sat Jan 01 2022 00:00:00 GMT+0800 (中国标准时间)
- * safeDate('2022.1.1'); // Sat Jan 01 2022 00:00:00 GMT+0800 (中国标准时间)
- * safeDate('2022.1.1 11:11'); // Sat Jan 01 2022 11:11:00 GMT+0800 (中国标准时间)
- * safeDate(99, 1); // Mon Feb 01 1999 00:00:00 GMT+0800 (中国标准时间)
- * safeDate(1646711233171); // Tue Mar 08 2022 11:47:13 GMT+0800 (中国标准时间)
- */
 declare function safeDate(): Date;
 declare function safeDate(value: number | string | Date): Date;
 declare function safeDate(year: number, monthIndex: number, date?: number, hours?: number, minutes?: number, seconds?: number, ms?: number): Date;

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/type/isBlob.d.ts

@@ -1,5 +1,5 @@
 /**
- * 检查值是否为Blob对象<br/><br/>
+ * 检查值是否为Blob对象
  *
  * <em style="font-weight: bold;">注意：该方法仅适用于浏览器端。</em>
  *

package/types/utils/type/isError.d.ts

@@ -1,11 +1,11 @@
 /**
- * 检查值是否为Error、EvalError、RangeError、ReferenceError、SyntaxError、TypeError、URIError|DOMException
+ * 检查值是否为Error、EvalError、RangeError、ReferenceError、SyntaxError、TypeError、URIError | DOMException
  *
  * @static
  * @alias module:Type.isError
  * @since 1.1.0
  * @param {*} value 检查值
- * @returns {boolean} 是否为Error、EvalError、RangeError、ReferenceError、SyntaxError、TypeError、URIError|DOMException
+ * @returns {boolean} 是否为Error、EvalError、RangeError、ReferenceError、SyntaxError、TypeError、URIError | DOMException
  * @example
  *
  * isError(new Error)

package/types/utils/type/isNil.d.ts

@@ -2,7 +2,7 @@
  * 检查值是否为 undefined 或 null
  *
  * @static
- * @alias module:Type.isNaN
+ * @alias module:Type.isNil
  * @since 4.3.0
  * @param {*} value 检查值
  * @returns {boolean} 是否为 undefined 或 null