@zenweb/cache 4.0.0 → 4.0.1

package/CHANGELOG.md

@@ -1,4 +1,7 @@
 # Changelog
 
+## [4.0.1] - 2023-8-17
+cached 中间件增加 type 参数
+
 ## [4.0.0] - 2023-8-8
 发布

package/dist/middleware.d.ts

@@ -1,8 +1,18 @@
 import { Context, Middleware } from "@zenweb/core";
 import { LockGetOption } from "./types";
+interface CachedMiddlewareOption extends Omit<LockGetOption, 'parse' | 'decompress'> {
+    /**
+     * 输出内容类型
+     * - 默认 json
+     * - 需要指定输出类型，因为缓存的是 body 主体，并不包含类型
+     */
+    type?: string;
+}
 /**
  * 缓存中间件
+ * - 缓存中间件缓存的是 ctx.body 最终结果，所以可以缓存任何返回类型
  * - 会根据客户端请求头判断是否需要解压
  * @param key 缓存 key 如果不指定则默认使用 ctx.path
  */
-export declare function cached(key?: string | ((ctx: Context) => string | Promise<string>), opt?: Omit<LockGetOption, 'parse' | 'decompress'>): Middleware;
+export declare function cached(key?: string | ((ctx: Context) => string | Promise<string>), opt?: CachedMiddlewareOption): Middleware;
+export {};

package/dist/middleware.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.cached = void 0;
 /**
  * 缓存中间件
+ * - 缓存中间件缓存的是 ctx.body 最终结果，所以可以缓存任何返回类型
  * - 会根据客户端请求头判断是否需要解压
  * @param key 缓存 key 如果不指定则默认使用 ctx.path
  */
@@ -21,6 +22,9 @@ function cached(key, opt) {
         if (!decompress && result.compressed) {
             ctx.set('Content-Encoding', 'gzip');
         }
+        if (!ctx.type) {
+            ctx.type = (opt === null || opt === void 0 ? void 0 : opt.type) || 'json';
+        }
         ctx.body = result.data;
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zenweb/cache",
-  "version": "4.0.0",
+  "version": "4.0.1",
   "description": "Zenweb Cache module",
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",