util-helpers 4.21.4 → 4.21.6

package/esm/VERSION.js

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

package/esm/compressImage.js

@@ -1,5 +1,6 @@
 import { toNumber } from 'ut2';
 import loadImageWithBlob from './loadImageWithBlob.js';
+import { nativeUndefined } from './utils/native.js';
 
 function canvasToBlob(canvas, type, quality) {
     return new Promise(function (resolve) {
@@ -8,7 +9,7 @@ function canvasToBlob(canvas, type, quality) {
         }, type, quality);
     });
 }
-function compressImage(img, options) {
+var compressImage = function (img, options) {
     if (options === void 0) { options = {}; }
     return new Promise(function (resolve, reject) {
         var width = options.width, height = options.height, rotate = options.rotate, _a = options.offset, offset = _a === void 0 ? [0, 0] : _a, _b = options.cacheImage, cacheImage = _b === void 0 ? true : _b, _c = options.background, background = _c === void 0 ? '#fff' : _c, canvasWidth = options.canvasWidth, canvasHeight = options.canvasHeight, _d = options.format, format = _d === void 0 ? 'blob' : _d, _e = options.type, type = _e === void 0 ? 'image/jpeg' : _e, _f = options.quality, quality = _f === void 0 ? 0.8 : _f, beforeCompress = options.beforeCompress, beforeDraw = options.beforeDraw, afterDraw = options.afterDraw, ajaxOptions = options.ajaxOptions;
@@ -41,7 +42,7 @@ function compressImage(img, options) {
                 ctx.fillRect(0, 0, canvas.width, canvas.height);
             }
             var internalOffset = [0, 0];
-            if (rotate !== undefined) {
+            if (rotate !== nativeUndefined) {
                 ctx.translate(image.width / 2, image.height / 2);
                 internalOffset = [-image.width / 2, -image.height / 2];
                 ctx.rotate((rotate * Math.PI) / 180);
@@ -65,6 +66,7 @@ function compressImage(img, options) {
         })
             .catch(reject);
     });
-}
+};
+var compressImage$1 = compressImage;
 
-export { compressImage as default };
+export { compressImage$1 as default };

package/esm/download.js

@@ -3,7 +3,7 @@ import { isBlob, isPromiseLike } from 'ut2';
 import dataURLToBlob from './dataURLToBlob.js';
 import isUrl from './isUrl.js';
 import ajax from './ajax.js';
-import { createObjectURL, revokeObjectURL } from './utils/native.js';
+import { createObjectURL, revokeObjectURL, nativeUndefined } from './utils/native.js';
 
 function saver(blobUrl, fileName) {
     if (fileName === void 0) { fileName = ''; }
@@ -59,7 +59,7 @@ function download(data, options) {
                 case 5:
                     res = _a.sent();
                     currentFileName = fileName || data.split('?')[0].split('#')[0].split('/').pop();
-                    return [2, download(res, { fileName: currentFileName, type: type || (isBlob(res) ? res.type : undefined) })];
+                    return [2, download(res, { fileName: currentFileName, type: type || (isBlob(res) ? res.type : nativeUndefined) })];
                 case 6:
                     payload = new Blob([data], { type: type || 'text/plain' });
                     _a.label = 7;

package/esm/fileReader.js

@@ -4,7 +4,7 @@ var FileReaderMethodMap = {
     dataURL: 'readAsDataURL',
     text: 'readAsText'
 };
-function fileReader(blob, type) {
+var fileReader = function (blob, type) {
     if (type === void 0) { type = 'dataURL'; }
     var method = FileReaderMethodMap[type];
     if (!method) {
@@ -16,6 +16,7 @@ function fileReader(blob, type) {
         reader.onload = function () { return resolve(reader.result); };
         reader.onerror = function (error) { return reject(error); };
     });
-}
+};
+var fileReader$1 = fileReader;
 
-export { fileReader as default };
+export { fileReader$1 as default };

package/esm/index.js

@@ -64,6 +64,6 @@ export { default as findTreeSelect } from './findTreeSelect.js';
 export { setDisableWarning } from './utils/config.js';
 export { default as VERSION } from './VERSION.js';
 
-var version = "4.21.4";
+var version = "4.21.6";
 
 export { version };

package/esm/isChinese.js

@@ -1,5 +1,5 @@
 import { toString } from 'ut2';
-import { objectValues } from './utils/native.js';
+import { objectValues, nativeUndefined } from './utils/native.js';
 
 var chineseDictionary = {
     chineseBasic: '[\u4e00-\u9fa5]',
@@ -29,7 +29,7 @@ function isChinese(value, options) {
     var extendRegExp = loose ? looseChineseExtendRegExp : chineseExtendRegExp;
     var hasExtend = useExtend && supportRegExpUnicode;
     var resultRegExp = hasExtend ? extendRegExp : basicRegExp;
-    var flag = hasExtend ? 'u' : undefined;
+    var flag = hasExtend ? 'u' : nativeUndefined;
     var reg = new RegExp(resultRegExp, flag);
     return reg.test(valueStr);
 }

package/esm/node_modules/.pnpm/emitter-pro@1.2.1/node_modules/emitter-pro/dist/emitter-pro.esm.js

@@ -0,0 +1,98 @@
+var EmitterPro = /** @class */ (function () {
+    function EmitterPro() {
+        this.handlers = {};
+    }
+    EmitterPro.prototype.eventNames = function () {
+        var _a;
+        var symbols = ((_a = Object.getOwnPropertySymbols) === null || _a === void 0 ? void 0 : _a.call(Object, this.handlers)) || [];
+        var keys = Object.keys(this.handlers);
+        return keys.concat(symbols);
+    };
+    EmitterPro.prototype.rawListeners = function (eventName) {
+        var handler = this.handlers[eventName];
+        return handler ? handler.map(function (item) { return item.raw; }) : [];
+    };
+    EmitterPro.prototype.listeners = function (eventName) {
+        var handler = this.handlers[eventName];
+        return handler ? handler.map(function (item) { return item.wrap; }) : [];
+    };
+    EmitterPro.prototype.hasListener = function (eventName, listener) {
+        return this.rawListeners(eventName).some(function (item) { return item === listener; });
+    };
+    EmitterPro.prototype._on = function (eventName, raw, wrap, context, dir) {
+        if (context === void 0) { context = null; }
+        if (dir === void 0) { dir = 1; }
+        var currentListener = { raw: raw, wrap: wrap, context: context };
+        if (!this.handlers[eventName]) {
+            this.handlers[eventName] = [currentListener];
+        }
+        else {
+            var appendMethod = dir === 1 ? 'push' : 'unshift';
+            this.handlers[eventName][appendMethod](currentListener);
+        }
+        return this;
+    };
+    EmitterPro.prototype.prependListener = function (eventName, listener, context) {
+        return this._on(eventName, listener, listener, context, 0);
+    };
+    EmitterPro.prototype.on = function (eventName, listener, context) {
+        return this._on(eventName, listener, listener, context);
+    };
+    EmitterPro.prototype._wrapOnce = function (eventName, listener, context) {
+        var _this = this;
+        if (context === void 0) { context = null; }
+        var wrap = (function () {
+            var args = [];
+            for (var _i = 0; _i < arguments.length; _i++) {
+                args[_i] = arguments[_i];
+            }
+            listener.apply(context, args);
+            _this.off(eventName, wrap);
+        });
+        return wrap;
+    };
+    EmitterPro.prototype.once = function (eventName, listener, context) {
+        var wrap = this._wrapOnce(eventName, listener, context);
+        return this._on(eventName, listener, wrap, context);
+    };
+    EmitterPro.prototype.prependOnceListener = function (eventName, listener, context) {
+        var wrap = this._wrapOnce(eventName, listener, context);
+        return this._on(eventName, listener, wrap, context, 0);
+    };
+    EmitterPro.prototype.off = function (eventName, listener) {
+        var handler = this.handlers[eventName];
+        if (handler) {
+            if (listener) {
+                var index = handler.findIndex(function (item) { return item.wrap === listener || item.raw === listener; });
+                if (index !== -1) {
+                    handler.splice(index, 1);
+                }
+            }
+            else {
+                delete this.handlers[eventName];
+            }
+        }
+        return this;
+    };
+    EmitterPro.prototype.offAll = function () {
+        this.handlers = {};
+        return this;
+    };
+    EmitterPro.prototype.emit = function (eventName) {
+        var args = [];
+        for (var _i = 1; _i < arguments.length; _i++) {
+            args[_i - 1] = arguments[_i];
+        }
+        var handler = this.handlers[eventName];
+        if (handler && handler.length > 0) {
+            handler.forEach(function (listener) {
+                listener.wrap.apply(listener.context, args);
+            });
+            return true;
+        }
+        return false;
+    };
+    return EmitterPro;
+}());
+
+export { EmitterPro as default };

package/esm/safeDate.js

@@ -1,6 +1,6 @@
 import { __spreadArray, __read } from 'tslib';
 
-function safeDate(value) {
+var safeDate = function (value) {
     var args = [];
     for (var _i = 1; _i < arguments.length; _i++) {
         args[_i - 1] = arguments[_i];
@@ -10,6 +10,7 @@ function safeDate(value) {
         return new (Date.bind.apply(Date, __spreadArray([void 0, safeValue], __read(args), false)))();
     }
     return typeof safeValue === 'undefined' ? new Date() : new Date(safeValue);
-}
+};
+var safeDate$1 = safeDate;
 
-export { safeDate as default };
+export { safeDate$1 as default };

package/esm/utils/Cache.js

@@ -1,5 +1,5 @@
 import { __extends, __assign } from 'tslib';
-import EmitterPro from '../node_modules/.pnpm/emitter-pro@1.0.3/node_modules/emitter-pro/dist/emitter-pro.esm.js';
+import EmitterPro from '../node_modules/.pnpm/emitter-pro@1.2.1/node_modules/emitter-pro/dist/emitter-pro.esm.js';
 import { forEach } from 'ut2';
 
 var Cache = (function (_super) {

package/esm/utils/native.js

@@ -1,9 +1,10 @@
 import { constant, noop } from 'ut2';
 import { URLExisted } from './setup.js';
 
+var nativeUndefined = void 0;
 var objectKeys = Object.keys;
 var objectValues = Object.values;
 var createObjectURL = URLExisted ? URL.createObjectURL : constant('');
 var revokeObjectURL = URLExisted ? URL.revokeObjectURL : noop;
 
-export { createObjectURL, objectKeys, objectValues, revokeObjectURL };
+export { createObjectURL, nativeUndefined, objectKeys, objectValues, revokeObjectURL };

package/lib/VERSION.js

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

package/lib/compressImage.js

@@ -2,6 +2,7 @@
 
 var ut2 = require('ut2');
 var loadImageWithBlob = require('./loadImageWithBlob.js');
+var native = require('./utils/native.js');
 
 function canvasToBlob(canvas, type, quality) {
     return new Promise(function (resolve) {
@@ -10,7 +11,7 @@ function canvasToBlob(canvas, type, quality) {
         }, type, quality);
     });
 }
-function compressImage(img, options) {
+var compressImage = function (img, options) {
     if (options === void 0) { options = {}; }
     return new Promise(function (resolve, reject) {
         var width = options.width, height = options.height, rotate = options.rotate, _a = options.offset, offset = _a === void 0 ? [0, 0] : _a, _b = options.cacheImage, cacheImage = _b === void 0 ? true : _b, _c = options.background, background = _c === void 0 ? '#fff' : _c, canvasWidth = options.canvasWidth, canvasHeight = options.canvasHeight, _d = options.format, format = _d === void 0 ? 'blob' : _d, _e = options.type, type = _e === void 0 ? 'image/jpeg' : _e, _f = options.quality, quality = _f === void 0 ? 0.8 : _f, beforeCompress = options.beforeCompress, beforeDraw = options.beforeDraw, afterDraw = options.afterDraw, ajaxOptions = options.ajaxOptions;
@@ -43,7 +44,7 @@ function compressImage(img, options) {
                 ctx.fillRect(0, 0, canvas.width, canvas.height);
             }
             var internalOffset = [0, 0];
-            if (rotate !== undefined) {
+            if (rotate !== native.nativeUndefined) {
                 ctx.translate(image.width / 2, image.height / 2);
                 internalOffset = [-image.width / 2, -image.height / 2];
                 ctx.rotate((rotate * Math.PI) / 180);
@@ -67,6 +68,7 @@ function compressImage(img, options) {
         })
             .catch(reject);
     });
-}
+};
+var compressImage$1 = compressImage;
 
-module.exports = compressImage;
+module.exports = compressImage$1;

package/lib/download.js

@@ -61,7 +61,7 @@ function download(data, options) {
                 case 5:
                     res = _a.sent();
                     currentFileName = fileName || data.split('?')[0].split('#')[0].split('/').pop();
-                    return [2, download(res, { fileName: currentFileName, type: type || (ut2.isBlob(res) ? res.type : undefined) })];
+                    return [2, download(res, { fileName: currentFileName, type: type || (ut2.isBlob(res) ? res.type : native.nativeUndefined) })];
                 case 6:
                     payload = new Blob([data], { type: type || 'text/plain' });
                     _a.label = 7;

package/lib/fileReader.js

@@ -6,7 +6,7 @@ var FileReaderMethodMap = {
     dataURL: 'readAsDataURL',
     text: 'readAsText'
 };
-function fileReader(blob, type) {
+var fileReader = function (blob, type) {
     if (type === void 0) { type = 'dataURL'; }
     var method = FileReaderMethodMap[type];
     if (!method) {
@@ -18,6 +18,7 @@ function fileReader(blob, type) {
         reader.onload = function () { return resolve(reader.result); };
         reader.onerror = function (error) { return reject(error); };
     });
-}
+};
+var fileReader$1 = fileReader;
 
-module.exports = fileReader;
+module.exports = fileReader$1;

package/lib/index.js

@@ -66,7 +66,7 @@ var findTreeSelect = require('./findTreeSelect.js');
 var config = require('./utils/config.js');
 var VERSION = require('./VERSION.js');
 
-exports.version = "4.21.4";
+exports.version = "4.21.6";
 
 exports.isMobile = isMobile;
 exports.isTelephone = isTelephone;

package/lib/isChinese.js

@@ -31,7 +31,7 @@ function isChinese(value, options) {
     var extendRegExp = loose ? looseChineseExtendRegExp : chineseExtendRegExp;
     var hasExtend = useExtend && supportRegExpUnicode;
     var resultRegExp = hasExtend ? extendRegExp : basicRegExp;
-    var flag = hasExtend ? 'u' : undefined;
+    var flag = hasExtend ? 'u' : native.nativeUndefined;
     var reg = new RegExp(resultRegExp, flag);
     return reg.test(valueStr);
 }

package/lib/node_modules/.pnpm/emitter-pro@1.2.1/node_modules/emitter-pro/dist/emitter-pro.esm.js

@@ -0,0 +1,100 @@
+'use strict';
+
+exports.default = /** @class */ (function () {
+    function EmitterPro() {
+        this.handlers = {};
+    }
+    EmitterPro.prototype.eventNames = function () {
+        var _a;
+        var symbols = ((_a = Object.getOwnPropertySymbols) === null || _a === void 0 ? void 0 : _a.call(Object, this.handlers)) || [];
+        var keys = Object.keys(this.handlers);
+        return keys.concat(symbols);
+    };
+    EmitterPro.prototype.rawListeners = function (eventName) {
+        var handler = this.handlers[eventName];
+        return handler ? handler.map(function (item) { return item.raw; }) : [];
+    };
+    EmitterPro.prototype.listeners = function (eventName) {
+        var handler = this.handlers[eventName];
+        return handler ? handler.map(function (item) { return item.wrap; }) : [];
+    };
+    EmitterPro.prototype.hasListener = function (eventName, listener) {
+        return this.rawListeners(eventName).some(function (item) { return item === listener; });
+    };
+    EmitterPro.prototype._on = function (eventName, raw, wrap, context, dir) {
+        if (context === void 0) { context = null; }
+        if (dir === void 0) { dir = 1; }
+        var currentListener = { raw: raw, wrap: wrap, context: context };
+        if (!this.handlers[eventName]) {
+            this.handlers[eventName] = [currentListener];
+        }
+        else {
+            var appendMethod = dir === 1 ? 'push' : 'unshift';
+            this.handlers[eventName][appendMethod](currentListener);
+        }
+        return this;
+    };
+    EmitterPro.prototype.prependListener = function (eventName, listener, context) {
+        return this._on(eventName, listener, listener, context, 0);
+    };
+    EmitterPro.prototype.on = function (eventName, listener, context) {
+        return this._on(eventName, listener, listener, context);
+    };
+    EmitterPro.prototype._wrapOnce = function (eventName, listener, context) {
+        var _this = this;
+        if (context === void 0) { context = null; }
+        var wrap = (function () {
+            var args = [];
+            for (var _i = 0; _i < arguments.length; _i++) {
+                args[_i] = arguments[_i];
+            }
+            listener.apply(context, args);
+            _this.off(eventName, wrap);
+        });
+        return wrap;
+    };
+    EmitterPro.prototype.once = function (eventName, listener, context) {
+        var wrap = this._wrapOnce(eventName, listener, context);
+        return this._on(eventName, listener, wrap, context);
+    };
+    EmitterPro.prototype.prependOnceListener = function (eventName, listener, context) {
+        var wrap = this._wrapOnce(eventName, listener, context);
+        return this._on(eventName, listener, wrap, context, 0);
+    };
+    EmitterPro.prototype.off = function (eventName, listener) {
+        var handler = this.handlers[eventName];
+        if (handler) {
+            if (listener) {
+                var index = handler.findIndex(function (item) { return item.wrap === listener || item.raw === listener; });
+                if (index !== -1) {
+                    handler.splice(index, 1);
+                }
+            }
+            else {
+                delete this.handlers[eventName];
+            }
+        }
+        return this;
+    };
+    EmitterPro.prototype.offAll = function () {
+        this.handlers = {};
+        return this;
+    };
+    EmitterPro.prototype.emit = function (eventName) {
+        var args = [];
+        for (var _i = 1; _i < arguments.length; _i++) {
+            args[_i - 1] = arguments[_i];
+        }
+        var handler = this.handlers[eventName];
+        if (handler && handler.length > 0) {
+            handler.forEach(function (listener) {
+                listener.wrap.apply(listener.context, args);
+            });
+            return true;
+        }
+        return false;
+    };
+    return EmitterPro;
+}());
+
+module.exports = exports.default;

package/lib/safeDate.js

@@ -2,7 +2,7 @@
 
 var tslib = require('tslib');
 
-function safeDate(value) {
+var safeDate = function (value) {
     var args = [];
     for (var _i = 1; _i < arguments.length; _i++) {
         args[_i - 1] = arguments[_i];
@@ -12,6 +12,7 @@ function safeDate(value) {
         return new (Date.bind.apply(Date, tslib.__spreadArray([void 0, safeValue], tslib.__read(args), false)))();
     }
     return typeof safeValue === 'undefined' ? new Date() : new Date(safeValue);
-}
+};
+var safeDate$1 = safeDate;
 
-module.exports = safeDate;
+module.exports = safeDate$1;

package/lib/utils/Cache.js

@@ -1,7 +1,7 @@
 'use strict';
 
 var tslib = require('tslib');
-var emitterPro_esm = require('../node_modules/.pnpm/emitter-pro@1.0.3/node_modules/emitter-pro/dist/emitter-pro.esm.js');
+var emitterPro_esm = require('../node_modules/.pnpm/emitter-pro@1.2.1/node_modules/emitter-pro/dist/emitter-pro.esm.js');
 var ut2 = require('ut2');
 
 var Cache = (function (_super) {

package/lib/utils/native.js

@@ -3,6 +3,7 @@
 var ut2 = require('ut2');
 var setup = require('./setup.js');
 
+exports.nativeUndefined = void 0;
 exports.objectKeys = Object.keys;
 exports.objectValues = Object.values;
 exports.createObjectURL = setup.URLExisted ? URL.createObjectURL : ut2.constant('');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "util-helpers",
-  "version": "4.21.4",
+  "version": "4.21.6",
   "description": "一个基于业务场景的工具方法库",
   "main": "lib/index.js",
   "module": "esm/index.js",
@@ -51,8 +51,8 @@
   },
   "homepage": "https://doly-dev.github.io/util-helpers/index.html",
   "devDependencies": {
-    "@babel/core": "^7.24.3",
-    "@babel/preset-env": "^7.24.3",
+    "@babel/core": "^7.24.4",
+    "@babel/preset-env": "^7.24.4",
     "@babel/preset-typescript": "^7.24.1",
     "@commitlint/cli": "^17.8.1",
     "@commitlint/config-conventional": "^17.8.1",
@@ -63,8 +63,8 @@
     "@rollup/plugin-terser": "^0.4.4",
     "@rollup/plugin-typescript": "^11.1.6",
     "@types/jest": "^29.5.12",
-    "@typescript-eslint/eslint-plugin": "^7.3.1",
-    "@typescript-eslint/parser": "^7.3.1",
+    "@typescript-eslint/eslint-plugin": "^7.7.0",
+    "@typescript-eslint/parser": "^7.7.0",
     "babel-jest": "^29.7.0",
     "babel-plugin-minify-replace": "^0.5.0",
     "commitizen": "^4.3.0",
@@ -72,15 +72,15 @@
     "docdash": "^2.0.2",
     "eslint": "^8.57.0",
     "husky": "^9.0.11",
-    "inquirer": "8",
+    "inquirer": "^8.2.6",
     "jest": "^29.7.0",
     "jest-canvas-mock": "^2.5.2",
     "jest-environment-jsdom": "^29.7.0",
     "jsdoc": "^4.0.2",
     "lint-staged": "^13.3.0",
     "prettier": "^3.2.5",
-    "rollup": "^4.13.0",
-    "typescript": "^5.4.3"
+    "rollup": "^4.14.3",
+    "typescript": "^5.4.5"
   },
   "lint-staged": {
     "**/*.ts": "eslint",
@@ -92,7 +92,7 @@
     }
   },
   "dependencies": {
-    "emitter-pro": "^1.0.3",
+    "emitter-pro": "^1.2.1",
     "tslib": "^2.6.2",
     "ut2": "^1.7.1"
   },

package/types/compressImage.d.ts

@@ -22,8 +22,70 @@ type Options = {
     cacheImage?: boolean | Parameters<typeof loadImageWithBlob>[1];
     ajaxOptions?: Parameters<typeof loadImageWithBlob>[2];
 };
-declare function compressImage(img: string | Blob, options: Omit<Options, 'format'> & {
-    format: 'dataURL';
-}): Promise<string>;
-declare function compressImage(img: string | Blob, options?: Options): Promise<Blob>;
+interface CompressImage {
+    (img: string | Blob, options: Omit<Options, 'format'> & {
+        format: 'dataURL';
+    }): Promise<string>;
+    (img: string | Blob, options?: Options): Promise<Blob>;
+}
+/**
+ * 压缩图片。
+ *
+ * <em style="font-weight: bold;">注意：该方法仅适用于浏览器端。</em>
+ *
+ * <em style="font-weight: bold;">如果是半透明图片并且导出 `image/png` 格式，建议将背景变成透明 `background=transparent`，避免出现白边。注意正常图片压缩导出 `image/png` 格式后文件可能会比原图大。</em>
+ *
+ * @function
+ * @alias module:Other.compressImage
+ * @since 4.20.0
+ * @see {@link https://sytpwg.csb.app/ | 在线示例}
+ * @param {string | Blob} img 图片地址或 blob 对象
+ * @param {Object} [options] 配置项
+ * @param {number} [options.width] 自定义图片宽度，默认图片自身宽度
+ * @param {number} [options.height] 自定义图片高度，默认图片自身高度
+ * @param {number} [options.rotate] 旋转
+ * @param {Array | function} [options.offset=[0, 0]] x,y轴偏移值
+ * @param {string} [options.background=#fff] 背景颜色
+ * @param {number | function} [options.canvasWidth] 画布宽度，默认图片宽度
+ * @param {number | function} [options.canvasHeight] 画布高度，默认图片高度
+ * @param {'blob' | 'dataURL'} [options.format='blob'] 导出格式
+ * @param {string} [options.type='image/jpeg'] 图片类型
+ * @param {number} [options.quality=0.8] 图片质量
+ * @param {function} [options.beforeCompress] 图片加载完成，画布创建之前调用
+ * @param {function} [options.beforeDraw] 图片载入画布之前调用
+ * @param {function} [options.afterDraw] 图片载入画布之后调用
+ * @param {boolean | CacheOptions} [options.cacheImage=true] 是否使用 `loadImageWithBlob` 缓存。
+ * @param {AjaxOptions} [options.ajaxOptions] ajax 请求配置项，当传入的图片为字符串时才会触发请求。
+ * @returns {Promise<Blob | string>} blob 对象 或 data url 图片
+ * @example
+ *
+ * // 默认返回压缩后的 blob 对象
+ * compressImage(file).then(blob=>{
+ *    // do something
+ * });
+ *
+ * // 设置返回格式 data url
+ * compressImage(file, { format: 'dataURL' }).then(url=>{
+ *    // do something
+ * });
+ *
+ * // 自定义配置
+ * compressImage('https://dummyimage.com/200x300', {
+ *  width: 100,
+ *  height: 100,
+ *  quality: 0.5,
+ *  beforeCompress({ image, blob }){},
+ *  beforeDraw({ image, blob, canvas, context }){}
+ *  afterDraw({ image, blob, canvas, context }){}
+ * }).then(blob=>{
+ *   // do something
+ * });
+ *
+ * // 支持不同形式的图片文件
+ * compressImage('data:image/png;base64,PGEgaWQ9ImEiPjxiIGlkPSJiIj5oZXkhPC9iPjwvYT4=').then(blob=>{
+ *   // do something
+ * });
+ *
+ */
+declare const compressImage: CompressImage;
 export default compressImage;

package/types/fileReader.d.ts

@@ -5,6 +5,35 @@ declare const FileReaderMethodMap: {
     readonly text: "readAsText";
 };
 type ReadType = keyof typeof FileReaderMethodMap;
-declare function fileReader(blob: Blob, type: 'arrayBuffer'): Promise<ArrayBuffer>;
-declare function fileReader(blob: Blob, type?: Exclude<ReadType, 'arrayBuffer'>): Promise<string>;
+interface FileReader {
+    (blob: Blob, type: 'arrayBuffer'): Promise<ArrayBuffer>;
+    (blob: Blob, type?: Exclude<ReadType, 'arrayBuffer'>): Promise<string>;
+}
+/**
+ * 读取 Blob 或 File 对象，转为 Base64/String/ArrayBuffer
+ *
+ * <em style="font-weight: bold;">注意：该方法仅适用于浏览器端。</em>
+ *
+ * @function
+ * @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 const fileReader: FileReader;
 export default fileReader;