util-helpers 5.1.3 → 5.2.1

package/esm/VERSION.js

@@ -1,4 +1,4 @@
-var VERSION = "5.1.3";
+var VERSION = "5.2.1";
 var VERSION$1 = VERSION;
 
 export { VERSION$1 as default };

package/esm/getFileType.js

@@ -3,9 +3,9 @@ import checkFileType from './checkFileType.js';
 import { isUploadFile } from './utils/file.util.js';
 
 var config = {
-    image: 'image/*,.jpeg,.jpg,.gif,.bmp,.png,.webp',
-    audio: 'audio/*,.mp3,.wav',
-    video: 'video/*,.mp4,.webm,.ogg,.ogv,.ogm',
+    image: 'image/*,.jpeg,.jpg,.gif,.bmp,.png,.webp,.svg,.apng,.avif,.ico,.tif,.tiff',
+    audio: 'audio/*,.mp3,.wav,.aac,.flac',
+    video: 'video/*,.mp4,.webm,.ogg,.mov',
     pdf: 'application/pdf,.pdf',
     word: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document,.doc,.docx',
     excel: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet,application/vnd.ms-excel,.xls,.xlsx'

package/esm/getMimeType.js

@@ -0,0 +1,43 @@
+import { isString, nth } from 'ut2';
+import { nativeUndefined } from './utils/native.js';
+
+var mimeTypes = [
+    ['text/plain', ['txt']],
+    ['text/css', ['css']],
+    ['text/html', ['htm', 'html']],
+    ['text/javascript', ['js', 'mjs']],
+    ['text/csv', ['csv']],
+    ['text/markdown', ['md', 'markdown']],
+    ['image/gif', ['gif']],
+    ['image/jpeg', ['jpg', 'jpeg', 'jfif', 'pjpeg', 'pjp']],
+    ['image/png', ['png']],
+    ['image/svg+xml', ['svg']],
+    ['image/webp', ['webp']],
+    ['image/apng', ['apng']],
+    ['image/avif', ['avif']],
+    ['image/bmp', ['bmp']],
+    ['image/x-icon', ['ico', 'cur']],
+    ['image/tiff', ['tif', 'tiff']],
+    ['application/xml', ['xml']],
+    ['application/zip', ['zip']],
+    ['application/pdf', ['pdf']],
+    ['application/json', ['json']],
+    ['application/yaml', ['yaml', 'yml']],
+    ['application/vnd.openxmlformats-officedocument.wordprocessingml.document', ['doc', 'docx']],
+    ['application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', ['xls', 'xlsx']],
+    ['audio/mp3', ['mp3']],
+    ['audio/wav', ['wav']],
+    ['audio/aac', ['aac']],
+    ['audio/flac', ['flac']],
+    ['video/mp4', ['mp4']],
+    ['video/ogg', ['ogg']],
+    ['video/webm', ['webm']],
+    ['video/quicktime', ['mov']]
+];
+function getMimeType(fileName) {
+    var _a;
+    var ext = isString(fileName) && fileName.indexOf('.') > 0 ? nth(fileName.split('.'), -1) : '';
+    return ext ? (_a = mimeTypes.find(function (item) { return item[1].includes(ext); })) === null || _a === void 0 ? void 0 : _a[0] : nativeUndefined;
+}
+
+export { getMimeType as default };

package/esm/index.js

@@ -48,6 +48,7 @@ export { default as download } from './download.js';
 export { default as getFileBlob } from './getFileBlob.js';
 export { default as getFileType } from './getFileType.js';
 export { default as getImageInfo } from './getImageInfo.js';
+export { default as getMimeType } from './getMimeType.js';
 export { default as loadImage } from './loadImage.js';
 export { default as loadImageWithBlob } from './loadImageWithBlob.js';
 export { default as loadScript } from './loadScript.js';

package/esm/utils/file.util.js

@@ -4,7 +4,7 @@ function testExt(name, ext) {
     return !!name && name.slice(-ext.length) === ext;
 }
 function isUploadFile(fileObj) {
-    if (isObjectLike(fileObj) && isString(fileObj.uid) && isString(fileObj.name)) {
+    if (isObjectLike(fileObj) && isString(fileObj.name)) {
         return true;
     }
     return false;

package/lib/VERSION.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var VERSION = "5.1.3";
+var VERSION = "5.2.1";
 var VERSION$1 = VERSION;
 
 module.exports = VERSION$1;

package/lib/getFileType.js

@@ -5,9 +5,9 @@ var checkFileType = require('./checkFileType.js');
 var file_util = require('./utils/file.util.js');
 
 var config = {
-    image: 'image/*,.jpeg,.jpg,.gif,.bmp,.png,.webp',
-    audio: 'audio/*,.mp3,.wav',
-    video: 'video/*,.mp4,.webm,.ogg,.ogv,.ogm',
+    image: 'image/*,.jpeg,.jpg,.gif,.bmp,.png,.webp,.svg,.apng,.avif,.ico,.tif,.tiff',
+    audio: 'audio/*,.mp3,.wav,.aac,.flac',
+    video: 'video/*,.mp4,.webm,.ogg,.mov',
     pdf: 'application/pdf,.pdf',
     word: 'application/vnd.openxmlformats-officedocument.wordprocessingml.document,.doc,.docx',
     excel: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet,application/vnd.ms-excel,.xls,.xlsx'

package/lib/getMimeType.js

@@ -0,0 +1,45 @@
+'use strict';
+
+var ut2 = require('ut2');
+var native = require('./utils/native.js');
+
+var mimeTypes = [
+    ['text/plain', ['txt']],
+    ['text/css', ['css']],
+    ['text/html', ['htm', 'html']],
+    ['text/javascript', ['js', 'mjs']],
+    ['text/csv', ['csv']],
+    ['text/markdown', ['md', 'markdown']],
+    ['image/gif', ['gif']],
+    ['image/jpeg', ['jpg', 'jpeg', 'jfif', 'pjpeg', 'pjp']],
+    ['image/png', ['png']],
+    ['image/svg+xml', ['svg']],
+    ['image/webp', ['webp']],
+    ['image/apng', ['apng']],
+    ['image/avif', ['avif']],
+    ['image/bmp', ['bmp']],
+    ['image/x-icon', ['ico', 'cur']],
+    ['image/tiff', ['tif', 'tiff']],
+    ['application/xml', ['xml']],
+    ['application/zip', ['zip']],
+    ['application/pdf', ['pdf']],
+    ['application/json', ['json']],
+    ['application/yaml', ['yaml', 'yml']],
+    ['application/vnd.openxmlformats-officedocument.wordprocessingml.document', ['doc', 'docx']],
+    ['application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', ['xls', 'xlsx']],
+    ['audio/mp3', ['mp3']],
+    ['audio/wav', ['wav']],
+    ['audio/aac', ['aac']],
+    ['audio/flac', ['flac']],
+    ['video/mp4', ['mp4']],
+    ['video/ogg', ['ogg']],
+    ['video/webm', ['webm']],
+    ['video/quicktime', ['mov']]
+];
+function getMimeType(fileName) {
+    var _a;
+    var ext = ut2.isString(fileName) && fileName.indexOf('.') > 0 ? ut2.nth(fileName.split('.'), -1) : '';
+    return ext ? (_a = mimeTypes.find(function (item) { return item[1].includes(ext); })) === null || _a === void 0 ? void 0 : _a[0] : native.nativeUndefined;
+}
+
+module.exports = getMimeType;

package/lib/index.js

@@ -50,6 +50,7 @@ var download = require('./download.js');
 var getFileBlob = require('./getFileBlob.js');
 var getFileType = require('./getFileType.js');
 var getImageInfo = require('./getImageInfo.js');
+var getMimeType = require('./getMimeType.js');
 var loadImage = require('./loadImage.js');
 var loadImageWithBlob = require('./loadImageWithBlob.js');
 var loadScript = require('./loadScript.js');
@@ -118,6 +119,7 @@ exports.download = download;
 exports.getFileBlob = getFileBlob;
 exports.getFileType = getFileType;
 exports.getImageInfo = getImageInfo;
+exports.getMimeType = getMimeType;
 exports.loadImage = loadImage;
 exports.loadImageWithBlob = loadImageWithBlob;
 exports.loadScript = loadScript;

package/lib/utils/file.util.js

@@ -6,7 +6,7 @@ function testExt(name, ext) {
     return !!name && name.slice(-ext.length) === ext;
 }
 function isUploadFile(fileObj) {
-    if (ut2.isObjectLike(fileObj) && ut2.isString(fileObj.uid) && ut2.isString(fileObj.name)) {
+    if (ut2.isObjectLike(fileObj) && ut2.isString(fileObj.name)) {
         return true;
     }
     return false;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "util-helpers",
-  "version": "5.1.3",
+  "version": "5.2.1",
   "description": "一个基于业务场景的工具方法库",
   "main": "lib/index.js",
   "module": "esm/index.js",
@@ -51,36 +51,36 @@
   },
   "homepage": "https://doly-dev.github.io/util-helpers/index.html",
   "devDependencies": {
-    "@babel/core": "^7.24.7",
-    "@babel/preset-env": "^7.24.7",
-    "@babel/preset-typescript": "^7.24.7",
+    "@babel/core": "^7.25.8",
+    "@babel/preset-env": "^7.25.8",
+    "@babel/preset-typescript": "^7.25.7",
     "@commitlint/cli": "^17.8.1",
     "@commitlint/config-conventional": "^17.8.1",
     "@commitlint/cz-commitlint": "^17.8.1",
     "@rollup/plugin-commonjs": "^25.0.8",
-    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-node-resolve": "^15.3.0",
     "@rollup/plugin-replace": "^5.0.7",
     "@rollup/plugin-terser": "^0.4.4",
     "@rollup/plugin-typescript": "^11.1.6",
-    "@types/jest": "^29.5.12",
-    "@typescript-eslint/eslint-plugin": "^7.16.0",
-    "@typescript-eslint/parser": "^7.16.0",
+    "@types/jest": "^29.5.13",
+    "@typescript-eslint/eslint-plugin": "^7.18.0",
+    "@typescript-eslint/parser": "^7.18.0",
     "babel-jest": "^29.7.0",
     "babel-plugin-minify-replace": "^0.5.0",
-    "commitizen": "^4.3.0",
+    "commitizen": "^4.3.1",
     "cross-env": "^7.0.3",
     "docdash": "^2.0.2",
-    "eslint": "^8.57.0",
-    "husky": "^9.0.11",
+    "eslint": "^8.57.1",
+    "husky": "^9.1.6",
     "inquirer": "^8.2.6",
     "jest": "^29.7.0",
     "jest-canvas-mock": "^2.5.2",
     "jest-environment-jsdom": "^29.7.0",
-    "jsdoc": "^4.0.3",
+    "jsdoc": "^4.0.4",
     "lint-staged": "^13.3.0",
-    "prettier": "^3.3.2",
-    "rollup": "^4.18.1",
-    "typescript": "^5.5.3"
+    "prettier": "^3.3.3",
+    "rollup": "^4.24.0",
+    "typescript": "^5.6.3"
   },
   "lint-staged": {
     "**/*.ts": "eslint",
@@ -92,9 +92,9 @@
     }
   },
   "dependencies": {
-    "cache2": "^3.0.0",
-    "tslib": "^2.6.3",
-    "ut2": "^1.11.0"
+    "cache2": "^3.1.1",
+    "tslib": "^2.8.0",
+    "ut2": "^1.13.0"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"

package/types/AsyncMemo.d.ts

@@ -8,7 +8,7 @@ import { Cache, CacheOptions } from 'cache2';
  * 3. 每个实例都有独立的缓存空间。相互之间隔离，缓存灵活配置，更多配置请查阅 [`cache2`](https://www.npmjs.com/package/cache2)。
  *
  * @class
- * @see {@link https://www.npmjs.com/package/cache2 cache2}
+ * @see {@link https://www.npmjs.com/package/cache2 | cache2}
  * @param {Object} [options] 缓存配置项，更多配置项可参考 [`cache2`](https://www.npmjs.com/package/cache2)
  * @param {number} [options.max] 最大缓存数量
  * @param {'replaced' | 'limited'} [options.maxStrategy] 缓存策略
@@ -25,7 +25,7 @@ import { Cache, CacheOptions } from 'cache2';
 declare class AsyncMemo<DataType = any> {
     private promiseCache;
     /**
-     * cache2 实例，用于管理缓存
+     * @summary cache2 实例，用于管理缓存
      */
     cache: Cache<DataType>;
     constructor(options?: Partial<CacheOptions>);

package/types/BlobUrl.d.ts

@@ -0,0 +1,41 @@
+/**
+ * Blob 对象 URL 记录。
+ *
+ * 便于管理项目中上传文件通过 `URL.createObjectURL` 生成的对象URL。
+ *
+ * 特点：
+ * 1. 避免重复创建，相同的 `Blob` 对象只会生成一个 URL 字符串
+ * 2. 当清除缓存时，自动释放内存
+ *
+ * @class
+ * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/API/URL/createObjectURL_static | URL：createObjectURL()}
+ * @example
+ * const blobUrl = new BlobUrl();
+ *
+ */
+declare class BlobUrl {
+    protected cache: Map<Blob, string>;
+    constructor();
+    /**
+     * 同 `URL.createObjectURL` 方法，创建一个对象 URL 字符串。
+     *
+     * 生成时内部会记录一个缓存，相同的 `Blob` 对象最多只会产生一个 URL 字符串。
+     *
+     * @param {Blob} obj 用于创建 URL 的 File、Blob 对象。
+     * @returns 一个包含对象 URL 的字符串，可用于引用指定源 object 的内容。
+     */
+    createObjectURL(obj: Blob): string | undefined;
+    /**
+     * 同 `URL.revokeObjectURL` 方法，释放对象 URL 。
+     *
+     * @param {string} url 通过调用 `createObjectURL()` 方法创建的对象 URL 的字符串。
+     */
+    revokeObjectURL(url: string): void;
+    /**
+     * 清理缓存。
+     *
+     * 迭代调用 `URL.revokeObjectURL` 来释放内存。
+     */
+    clear(): void;
+}
+export default BlobUrl;

package/types/VERSION.d.ts

@@ -1,6 +1,5 @@
 /**
- * util-helpers 版本号
- *
+ * @summary 版本号
  * @static
  * @since 4.18.0
  */

package/types/ajax.d.ts

@@ -19,7 +19,7 @@ type AjaxOptions = {
     onLoadEnd?: XMLHttpRequestListener;
 };
 /**
- * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/API/XMLHttpRequest XMLHttpRequest}
+ * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/API/XMLHttpRequest | XMLHttpRequest}
  * @typedef {Object} AjaxOptions ajax 配置项
  * @property {string} [method="get"] 创建请求时使用的方法
  * @property {boolean} [async=true] 是否异步执行操作
@@ -47,10 +47,27 @@ type AjaxOptions = {
  * @static
  * @alias module:Other.ajax
  * @since 4.16.0
- * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/API/XMLHttpRequest XMLHttpRequest}
+ * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/API/XMLHttpRequest | XMLHttpRequest}
  * @param {string} url 地址
- * @param {AjaxOptions} [options] 配置项
- * @returns {Promise<object>} XHR 事件对象
+ * @param {Object} [options] 配置项
+ * @param {string} [options.method="get"] 创建请求时使用的方法。默认 `'get'`。
+ * @param {boolean} [options.async=true] 是否异步执行操作。默认 `true`。
+ * @param {string|null} [options.user=null] 用户名，用于认证用途。默认 `null`。
+ * @param {string|null} [options.password=null] 密码，用于认证用途。默认 `null`。
+ * @param {Object} [options.headers] 自定义请求头。
+ * @param {string} [options.responseType] 响应类型。
+ * @param {number} [options.timeout] 请求超时的毫秒数。
+ * @param {boolean} [options.withCredentials=false] 跨域请求时是否需要使用凭证。默认 `false`。
+ * @param {*} [options.data=null] 请求体被发送的数据。默认 `null`。
+ * @param {function} [options.onReadyStateChange] 当 readyState 属性发生变化时触发。
+ * @param {function} [options.onLoadStart] 接收到响应数据时触发。
+ * @param {function} [options.onProgress] 请求接收到更多数据时，周期性地触发。
+ * @param {function} [options.onAbort] 当 request 被停止时触发，例如当程序调用 XMLHttpRequest.abort() 时。
+ * @param {function} [options.onTimeout] 在预设时间内没有接收到响应时触发。
+ * @param {function} [options.onError] 当 request 遭遇错误时触发。
+ * @param {function} [options.onLoad] 请求成功完成时触发。
+ * @param {function} [options.onLoadEnd] 请求结束时触发，无论请求成功 (load) 还是失败 (abort 或 error)。
+ * @returns {Promise<object>} XHR 事件对象。
  * @example
  * ajax('/somefile').then(res=>{
  *   // do something

package/types/calculateCursorPosition.d.ts

@@ -9,8 +9,8 @@ type CalculateCursorPositionOptions = {
  * @static
  * @alias module:Other.calculateCursorPosition
  * @since 4.6.0
- * @see {@link https://2950v9.csb.app/ h5示例}
- * @see {@link https://33ccy9.csb.app/ react示例}
+ * @see {@link https://2950v9.csb.app/ | h5示例}
+ * @see {@link https://33ccy9.csb.app/ | react示例}
  * @param {number} prevPos 赋值前的光标位置，onChange/onInput的光标位置 e.target.selectionEnd
  * @param {string} prevCtrlValue 上一个格式化后的值
  * @param {string} rawValue 当前输入原值

package/types/checkFileType.d.ts

@@ -5,8 +5,8 @@ import { UploadFile } from './utils/file.util';
  * @static
  * @alias module:Other.checkFileType
  * @since 5.1.0
- * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/input/file#唯一文件类型说明符 唯一文件类型说明符}
- * @see {@link https://www.iana.org/assignments/media-types/media-types.xhtml Media Types}
+ * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/HTML/Element/input/file#唯一文件类型说明符 | 唯一文件类型说明符}
+ * @see {@link https://www.iana.org/assignments/media-types/media-types.xhtml | Media Types}
  * @param {File} file 文件对象。支持 antd `UploadFile` 对象。
  * @param {string} [accept] 文件类型说明符。
  * @returns {boolean} 如果 `file` 符合 `accept` 返回 `true`， 否则返回 `false`。

package/types/compressImage.d.ts

@@ -37,7 +37,7 @@ interface CompressImage {
  * @function
  * @alias module:Other.compressImage
  * @since 4.20.0
- * @see {@link https://sytpwg.csb.app/ 在线示例}
+ * @see {@link https://sytpwg.csb.app/ | 在线示例}
  * @param {string | Blob} img 图片地址或 blob 对象
  * @param {Object} [options] 配置项
  * @param {number} [options.width] 自定义图片宽度，默认图片自身宽度

package/types/dataURLToBlob.d.ts

@@ -4,7 +4,7 @@
  * @static
  * @alias module:Processor.dataURLToBlob
  * @since 4.1.0
- * @see {@link https://developer.mozilla.org/zh-CN/docs/Glossary/Base64 Base64}
+ * @see {@link https://developer.mozilla.org/zh-CN/docs/Glossary/Base64 | Base64}
  * @param {string} data data: 协议的URL
  * @returns {Blob} Blob 对象
  * @example

package/types/download.d.ts

@@ -10,24 +10,6 @@ type DownloadOptions = {
     transformRequest?: TransformRequest;
     transformResponse?: TransformResponse;
 };
-/**
- * @callback TransformRequest
- * @param {AjaxOptions} options ajax 配置项
- * @returns {AjaxOptions | Promise<AjaxOptions>}
- */
-/**
- * @callback TransformResponse
- * @param {Blob} res 响应的Blob对象。如果你通过 transformRequest 修改了 responseType ，该参数将是该类型响应值。
- * @returns {Blob | Promise<Blob>}
- */
-/**
- * @typedef {Object} DownloadOptions 下载配置项
- * @property {string} [fileName] 文件名称
- * @property {string} [type] MIME 类型
- * @property {'url'|'text'} [dataType] 手动设置数据类型，默认会根据传入的数据判断类型，主要是为了区分 url 和 text 。<br/>如果你要下载的文本是 url ，请设置 'text' ；如果你要下载的 url 是绝对/相对路径，请设置 'url' 。
- * @property {TransformRequest} [transformRequest] 请求前触发，XHR 对象或配置调整
- * @property {TransformResponse} [transformResponse] 请求成功后触发，在传递给 then/catch 前，允许修改响应数据
- */
 /**
  * 下载
  *
@@ -40,11 +22,16 @@ type DownloadOptions = {
  * @static
  * @alias module:Other.download
  * @since 4.16.0
- * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Headers/Access-Control-Expose-Headers Access-Control-Expose-Headers}
- * @see {@link https://zh.wikipedia.org/wiki/多用途互聯網郵件擴展 MIME}
- * @see {@link https://9ykc9s.csb.app/ 在线示例}
+ * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Headers/Access-Control-Expose-Headers | Access-Control-Expose-Headers}
+ * @see {@link https://zh.wikipedia.org/wiki/多用途互聯網郵件擴展 | MIME}
+ * @see {@link https://9ykc9s.csb.app/ | 在线示例}
  * @param {string|Blob|ArrayBuffer|TypedArray} data 字符串、blob数据或url地址
- * @param {string|DownloadOptions} [options] 文件名称 或 配置项
+ * @param {string|Object} [options] 文件名称 或 配置项。
+ * @param {string} [options.fileName] 文件名称。
+ * @param {string} [options.type] MIME 类型。
+ * @param {'url'|'text'} [options.dataType] 手动设置数据类型，主要是为了区分 `url` 和 `text`，默认会根据传入的数据判断类型。<br/>如果你要下载的文本是 `url` ，请设置 `'text'` ；如果你要下载的 url 是绝对/相对路径，请设置 'url' 。
+ * @param {Function} [options.transformRequest] 请求前触发，XHR 对象或配置调整。
+ * @param {Function} [options.transformResponse] 请求成功后触发，在传递给 then/catch 前，允许修改响应数据。
  * @returns {Promise<void>}
  * @example
  * // 文本

package/types/fileReader.d.ts

@@ -16,7 +16,7 @@ interface FileReader {
  *
  * @function
  * @alias module:Processor.fileReader
- * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/API/FileReader 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'] 读取类型，默认`dataURL`。可选 `arrayBuffer`  `binaryString` `dataURL` `text` 。

package/types/gcd.d.ts

@@ -12,7 +12,7 @@
  * @static
  * @alias module:Math.gcd
  * @since 4.20.0
- * @see {@link https://baike.baidu.com/item/最大公约数 最大公约数}
+ * @see {@link https://baike.baidu.com/item/最大公约数 | 最大公约数}
  * @param {...(number|string)} nums 两个或多个整数。
  * @returns {number} 最大公约数。
  * @example

package/types/getFileType.d.ts

@@ -1,6 +1,6 @@
 import { UploadFile } from './utils/file.util';
 /**
- * 获取文件类型
+ * @summary 获取文件类型。
  *
  * @static
  * @alias module:Other.getFileType
@@ -16,6 +16,17 @@ import { UploadFile } from './utils/file.util';
  * getFileType(pdf); // 'pdf'
  * getFileType(jpeg); // 'image'
  *
+ * @description 内置文件类型和文件类型说明符
+ *
+ * | 类型 | 说明符 |
+ * |---|---|
+ * | `image` | `image/*,.jpeg,.jpg,.gif,.bmp,.png,.webp,.svg,.apng,.avif,.ico,.tif,.tiff` |
+ * | `audio` | `audio/*,.mp3,.wav,.aac,.flac` |
+ * | `video` | `video/*,.mp4,.webm,.ogg,.mov` |
+ * | `pdf` | `application/pdf,.pdf` |
+ * | `word` | `application/vnd.openxmlformats-officedocument.wordprocessingml.document,.doc,.docx` |
+ * | `excel` | `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet,application/vnd.ms-excel,.xls,.xlsx` |
+ *
  */
 declare function getFileType(file: File | UploadFile): "image" | "audio" | "video" | "pdf" | "word" | "excel" | undefined;
 export default getFileType;

package/types/getImageInfo.d.ts

@@ -18,13 +18,23 @@ import loadImageWithBlob from './loadImageWithBlob';
  * @static
  * @alias module:Other.getImageInfo
  * @since 4.20.0
- * @param {string | Blob} img 图片地址或 blob 对象
+ * @param {string | Blob} img 图片地址或 blob 对象。
  * @param {AjaxOptions} [ajaxOptions] ajax 请求配置项，当传入的图片为字符串时才会触发请求。
- * @returns {Promise<ImageInfo>} 图片信息
+ * @returns {Promise<ImageInfo>} 图片信息。
  * @example
  *
  * getImageInfo(file).then(imageInfo=>{
- *    // do something
+ *   console.log(imageInfo);
+ *   // {
+ *   //   width: 100,
+ *   //   height: 100,
+ *   //   contrast: '1:1',
+ *   //   measure: '100 × 100 px',
+ *   //   size: '11 B',
+ *   //   bytes: 11,
+ *   //   image: HTMLImageElement {},
+ *   //   blob: Blob {}
+ *   // }
  * });
  *
  * getImageInfo('https://dummyimage.com/200x300').then(imageInfo=>{

package/types/getMimeType.d.ts

@@ -0,0 +1,62 @@
+/**
+ * @summary 获取常用的 MIME 类型。通过文件名后缀查找对应的 MIME 类型。
+ *
+ * @alias module:Other.getMimeType
+ * @since 5.2.0
+ * @see {@link https://developer.mozilla.org/zh-CN/docs/Web/HTTP/MIME_types | MIME 类型（IANA 媒体类型）}
+ * @see {@link https://www.iana.org/assignments/media-types/media-types.xhtml | Media Types}
+ * @param {string} fileName 文件名。
+ * @returns 如果找到，返回 MIME 类型字符串，否则返回 `undefined`。
+ * @example
+ * getMimeType('xxx.png'); // 'image/png'
+ * getMimeType('xxx.jpg'); // 'image/jpeg'
+ * getMimeType('xxx.mp3'); // 'audio/mp3'
+ * getMimeType('xxx.mp4'); // 'video/mp4'
+ * getMimeType('xxx.pdf'); // 'application/pdf'
+ * getMimeType('xxx.zip'); // 'application/zip'
+ * getMimeType('xxx.doc'); // 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
+ *
+ * // 不常用或未知类型
+ * getMimeTye('xxx.ci'); // undefined
+ *
+ * // 非法文件名
+ * getMimeType('.zip'); // undefined
+ *
+ * @description 内置常用的 MIME 类型和文件名后缀映射
+ *
+ * | MIME 类型 | 文件名后缀 |
+ * |---|---|
+ * | `text/plain` | `txt` |
+ * | `text/css` | `css` |
+ * | `text/html` | `htm` `html` |
+ * | `text/javascript` | `js` `mjs` |
+ * | `text/csv` | `csv` |
+ * | `text/markdown` | `md` `markdown` |
+ * | `image/gif` | `gif` |
+ * | `image/jpeg` | `jpg` `jpeg` `jfif` `pjpeg` `pjp` |
+ * | `image/png` | `png` |
+ * | `image/svg+xml` | `svg` |
+ * | `image/webp` | `webp` |
+ * | `image/apng` | `apng` |
+ * | `image/avif` | `avif` |
+ * | `image/bmp` | `bmp` |
+ * | `image/x-icon` | `ico` `cur` |
+ * | `image/tiff` | `tif` `tiff` |
+ * | `application/xml` | `xml` |
+ * | `application/zip` | `zip` |
+ * | `application/pdf` | `pdf` |
+ * | `application/json` | `json` |
+ * | `application/yaml` | `yaml` `yml` |
+ * | `application/vnd.openxmlformats-officedocument.wordprocessingml.document` | `doc` `docx` |
+ * | `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` | `xls` `xlsx` |
+ * | `audio/mp3` | `mp3` |
+ * | `audio/wav` | `wav` |
+ * | `audio/aac` | `aac` |
+ * | `audio/flac` | `flac` |
+ * | `video/mp4` | `mp4` |
+ * | `video/ogg` | `ogg` |
+ * | `video/webm` | `webm` |
+ * | `video/quicktime` | `mov` |
+ */
+declare function getMimeType(fileName: string): string | undefined;
+export default getMimeType;

package/types/index.d.ts

@@ -50,8 +50,8 @@ export { default as transformObjectValue } from './transformObjectValue';
  *
  * @module Math
  * @since 3.1.0
- * @see {@link https://github.com/camsong/blog/issues/9 JavaScript 浮点数陷阱及解法}
- * @see {@link https://2zbuy.csb.app/ JS浮点数计算测试}
+ * @see {@link https://github.com/camsong/blog/issues/9 | JavaScript 浮点数陷阱及解法}
+ * @see {@link https://2zbuy.csb.app/ | JS浮点数计算测试}
  * @example
  * // 从 4.12.0 版本开始，规范了有效数值。（注意：4.12.3 对有效数值重新定义）
  * // 有效数值即能通过 Number(value) 转为数字，且不能为 NaN 。
@@ -105,6 +105,7 @@ export { default as download } from './download';
 export { default as getFileBlob } from './getFileBlob';
 export { default as getFileType } from './getFileType';
 export { default as getImageInfo } from './getImageInfo';
+export { default as getMimeType } from './getMimeType';
 export { default as loadImage } from './loadImage';
 export { default as loadImageWithBlob } from './loadImageWithBlob';
 export { default as loadScript } from './loadScript';

package/types/isBankCard.d.ts

@@ -8,7 +8,7 @@ type Options = {
  * @static
  * @alias module:Validator.isBankCard
  * @since 1.1.0
- * @see {@link https://kf.qq.com/faq/170112ABnm6b170112FvquAn.html 常用银行账号位数参考}
+ * @see {@link https://kf.qq.com/faq/170112ABnm6b170112FvquAn.html | 常用银行账号位数参考}
  * @param {*} value 要检测的值
  * @param {Object} [options] 配置项
  * @param {boolean} [options.loose=false] 宽松模式，默认`false`。正常模式10-21位数字（个人账户），宽松模式8-30位数字（企业账户）。

package/types/isBusinessLicense.d.ts

@@ -7,7 +7,7 @@ type Options = {
  * @static
  * @alias module:Validator.isBusinessLicense
  * @since 3.5.0
- * @see {@link https://wenku.baidu.com/view/19873704cc1755270722087c.html GS15—2006 工商行政管理市场主体注册号编制规则}
+ * @see {@link https://wenku.baidu.com/view/19873704cc1755270722087c.html | GS15—2006 工商行政管理市场主体注册号编制规则}
  * @param {*} value 要检测的值
  * @param {Object} [options] 配置项
  * @param {boolean} [options.checkCode=true] 是否校验最后一位校验码，默认`true`。如果为false，不校验校验位。