util-helpers 4.17.2 → 4.17.3

package/esm/utils/config.js

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

package/lib/utils/config.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "util-helpers",
-  "version": "4.17.2",
+  "version": "4.17.3",
   "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": {

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

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

package/types/numberToChinese.d.ts

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

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