@zenweb/cache 4.0.0 → 4.0.1-2

package/CHANGELOG.md

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

package/dist/global.js

@@ -7,7 +7,7 @@ const core_1 = require("@zenweb/core");
  */
 function getCache() {
     const ins = (0, core_1.getCore)();
-    return ins.cache;
+    return ins.cache2;
 }
 exports.getCache = getCache;
 /**

package/dist/index.d.ts

@@ -18,10 +18,10 @@ declare module '@zenweb/core' {
         /**
          * Redis 实例
          */
-        redis: Redis;
+        redis2: Redis;
         /**
          * 缓存实例
          */
-        cache: Cache;
+        cache2: Cache;
     }
 }

package/dist/index.js

@@ -48,8 +48,8 @@ function setup(option) {
         setup.debug('option: %o', opt);
         const redis = opt.redis instanceof ioredis_1.Redis ? opt.redis : new ioredis_1.Redis(opt.redis);
         await redis.ping('check');
-        setup.defineCoreProperty('redis', { value: redis });
-        setup.defineCoreProperty('cache', { value: new cache_1.Cache(redis, opt) });
+        setup.defineCoreProperty('redis2', { value: redis });
+        setup.defineCoreProperty('cache2', { value: new cache_1.Cache(redis, opt) });
         setup.destroy(async () => {
             setup.debug('quit redis...');
             await redis.quit();

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
  */
@@ -14,13 +15,16 @@ function cached(key, opt) {
             parse: false,
             decompress,
         });
-        const result = await ctx.core.cache.lockGet(_key, async function () {
+        const result = await ctx.core.cache2.lockGet(_key, async function () {
             await next();
             return ctx.body;
         }, _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-2",
   "description": "Zenweb Cache module",
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",