util-helpers 4.21.1 → 4.21.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "util-helpers",
-  "version": "4.21.1",
+  "version": "4.21.2",
   "description": "一个基于业务场景的工具方法库",
   "main": "lib/index.js",
   "module": "esm/index.js",
@@ -51,17 +51,17 @@
   },
   "homepage": "https://doly-dev.github.io/util-helpers/index.html",
   "devDependencies": {
-    "@babel/core": "^7.23.0",
-    "@babel/preset-env": "^7.22.20",
-    "@babel/preset-typescript": "^7.23.0",
-    "@commitlint/cli": "^17.7.2",
-    "@commitlint/config-conventional": "^17.7.0",
-    "@rollup/plugin-commonjs": "^25.0.5",
+    "@babel/core": "^7.23.9",
+    "@babel/preset-env": "^7.23.9",
+    "@babel/preset-typescript": "^7.23.3",
+    "@commitlint/cli": "^17.8.1",
+    "@commitlint/config-conventional": "^17.8.1",
+    "@rollup/plugin-commonjs": "^25.0.7",
     "@rollup/plugin-node-resolve": "^15.2.3",
-    "@rollup/plugin-replace": "^5.0.3",
+    "@rollup/plugin-replace": "^5.0.5",
     "@rollup/plugin-terser": "^0.4.4",
-    "@rollup/plugin-typescript": "^11.1.5",
-    "@types/jest": "^29.5.5",
+    "@rollup/plugin-typescript": "^11.1.6",
+    "@types/jest": "^29.5.12",
     "@typescript-eslint/eslint-plugin": "^5.62.0",
     "@typescript-eslint/parser": "^5.62.0",
     "babel-jest": "^29.7.0",
@@ -69,7 +69,7 @@
     "cross-env": "^7.0.3",
     "cz-conventional-changelog": "^3.3.0",
     "docdash": "^2.0.2",
-    "eslint": "^8.51.0",
+    "eslint": "^8.56.0",
     "husky": "^8.0.3",
     "jest": "^29.7.0",
     "jest-canvas-mock": "^2.5.2",
@@ -78,7 +78,7 @@
     "lint-staged": "^13.3.0",
     "prettier": "^2.8.8",
     "rollup": "^3.29.4",
-    "typescript": "^5.2.2"
+    "typescript": "^5.3.3"
   },
   "lint-staged": {
     "**/*.ts": "eslint",
@@ -90,8 +90,9 @@
     }
   },
   "dependencies": {
+    "emitter-pro": "^1.0.3",
     "tslib": "^2.6.2",
-    "ut2": "^1.5.2"
+    "ut2": "^1.7.1"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"

package/types/compressImage.d.ts

@@ -19,7 +19,7 @@ type Options = {
     beforeCompress?: (imageWithBlob: Pick<Info, 'image' | 'blob'>, options: Options) => void;
     beforeDraw?: (info: Info, options: Options) => void;
     afterDraw?: (info: Info, options: Options) => void;
-    cacheImage?: boolean;
+    cacheImage?: boolean | Parameters<typeof loadImageWithBlob>[1];
     ajaxOptions?: Parameters<typeof loadImageWithBlob>[2];
 };
 declare function compressImage(img: string | Blob, options: Omit<Options, 'format'> & {

package/types/getImageInfo.d.ts

@@ -1,16 +1,25 @@
 import loadImageWithBlob from './loadImageWithBlob';
+/**
+ * @typedef {Object} ImageInfo 图片信息
+ * @property {number} width 宽度
+ * @property {number} height 高度
+ * @property {string} contrast 宽高比
+ * @property {string} measure 尺寸
+ * @property {string} size 大小
+ * @property {number} bytes 大小，单位字节
+ * @property {HTMLImageElement} image HTML图片元素
+ * @property {Blob} blob 图片 Blob 对象
+ */
 /**
  * 获取图片信息。
  *
  * <em style="font-weight: bold;">注意：该方法仅适用于浏览器端。</em>
  *
- * <em style="font-weight: bold;">如果不需要该图片，建议手动调用 `URL.revokeObjectURL(image.src)` 释放缓存。</em>
- *
  * @static
  * @alias module:Other.getImageInfo
  * @since 4.20.0
  * @param {string | Blob} img 图片地址或 blob 对象
- * @param {boolean} [useCache=true] 缓存最近一次成功结果，当图片地址或 blob 对象一致时，直接返回该缓存。避免连续请求同一个图片资源，重复加载问题。
+ * @param {boolean | CacheOptions} [cacheOptions=true] 是否使用缓存。开启后，自动缓存最近上一次成功的结果，当图片地址或 blob 对象一致时，直接返回该缓存。避免连续请求同一个图片资源，重复加载。当缓存下一次成功加载的图片时，会自动释放上一次缓存的图片，也可以通过 `autoRevokeOnDel` 设置不释放缓存。
  * @param {AjaxOptions} [ajaxOptions] ajax 请求配置项，当传入的图片为字符串时才会触发请求。
  * @returns {Promise<ImageInfo>} 图片信息
  * @example
@@ -28,7 +37,7 @@ import loadImageWithBlob from './loadImageWithBlob';
  * });
  *
  */
-declare function getImageInfo(img: string | Blob, useCache?: boolean, ajaxOptions?: Parameters<typeof loadImageWithBlob>[2]): Promise<{
+declare function getImageInfo(img: string | Blob, cacheOptions?: boolean | Parameters<typeof loadImageWithBlob>[1], ajaxOptions?: Parameters<typeof loadImageWithBlob>[2]): Promise<{
     width: number;
     height: number;
     contrast: string;

package/types/loadImage.d.ts

@@ -1,15 +1,18 @@
+/**
+ * @typedef {Object} CacheOptions 缓存配置
+ * @property {boolean} [useCache=true] 是否使用缓存
+ * @property {boolean} [autoRevokeOnDel=true] 删除时自动释放缓存
+ */
 /**
  * 加载图片。
  *
  * <em style="font-weight: bold;">注意：该方法仅适用于浏览器端。</em>
  *
- * <em style="font-weight: bold;">如果不需要该图片，建议手动调用 `URL.revokeObjectURL(image.src)` 释放缓存。</em>
- *
  * @static
  * @alias module:Other.loadImage
  * @since 4.20.0
  * @param {string | Blob} img 图片地址或 blob 对象
- * @param {boolean} [useCache=true] 缓存最近一次成功结果，当图片地址或 blob 对象一致时，直接返回该缓存。避免连续请求同一个图片资源，重复加载问题。
+ * @param {boolean | CacheOptions} [cacheOptions=true] 是否使用缓存。开启后，自动缓存最近上一次成功的结果，当图片地址或 blob 对象一致时，直接返回该缓存。避免连续请求同一个图片资源，重复加载。当缓存下一次成功加载的图片时，会自动释放上一次缓存的图片，也可以通过 `autoRevokeOnDel` 设置不释放缓存。
  * @returns {Promise<HTMLImageElement>} HTML图片元素
  * @example
  *
@@ -26,5 +29,8 @@
  * });
  *
  */
-declare function loadImage(img: string | Blob, useCache?: boolean): Promise<HTMLImageElement>;
+declare function loadImage(img: string | Blob, cacheOptions?: boolean | {
+    useCache?: boolean;
+    autoRevokeOnDel?: boolean;
+}): Promise<HTMLImageElement>;
 export default loadImage;

package/types/loadImageWithBlob.d.ts

@@ -9,13 +9,11 @@ import getFileBlob from './getFileBlob';
  *
  * <em style="font-weight: bold;">注意：该方法仅适用于浏览器端。</em>
  *
- * <em style="font-weight: bold;">如果不需要该图片，建议手动调用 `URL.revokeObjectURL(image.src)` 释放缓存。</em>
- *
  * @method
  * @alias module:Other.loadImageWithBlob
  * @since 4.20.0
  * @param {string | Blob} img 图片地址或 blob 对象
- * @param {boolean} [useCache=true] 缓存最近一次成功结果，当图片地址或 blob 对象一致时，直接返回该缓存。避免连续请求同一个图片资源，重复加载问题。
+ * @param {boolean | CacheOptions} [cacheOptions=true] 是否使用缓存。开启后，自动缓存最近上一次成功的结果，当图片地址或 blob 对象一致时，直接返回该缓存。避免连续请求同一个图片资源，重复加载。当缓存下一次成功加载的图片时，会自动释放上一次缓存的图片，也可以通过 `autoRevokeOnDel` 设置不释放缓存。
  * @param {AjaxOptions} [ajaxOptions] ajax 请求配置项，当传入的图片为字符串时才会触发请求。
  * @returns {Promise<ImageWithBlob>} HTML图片元素和 blob 对象
  * @example
@@ -33,7 +31,10 @@ import getFileBlob from './getFileBlob';
  * });
  *
  */
-declare function loadImageWithBlob(img: string | Blob, useCache?: boolean, ajaxOptions?: Parameters<typeof getFileBlob>[1]): Promise<{
+declare function loadImageWithBlob(img: string | Blob, cacheOptions?: boolean | {
+    useCache?: boolean;
+    autoRevokeOnDel?: boolean;
+}, ajaxOptions?: Parameters<typeof getFileBlob>[1]): Promise<{
     image: HTMLImageElement;
     blob: Blob;
 }>;

package/types/utils/Cache.d.ts

@@ -0,0 +1,14 @@
+import Emitter from 'emitter-pro';
+type Options = {
+    max: number;
+};
+declare class Cache<V = any, K = any> extends Emitter<(v: V, k: K) => void> {
+    private data;
+    private options;
+    constructor(options?: Options);
+    has(k: K): boolean;
+    get(k: K): V | undefined;
+    private checkLimit;
+    set(k: K, v: V): void;
+}
+export default Cache;