@zenweb/cache 4.1.3 → 4.2.0

package/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## [4.2.0] - 2023-8-22
+更新: cached 中间件支持 null key，不使用缓存
+
 ## [4.1.3] - 2023-8-21
 fix: 二次获取缓存数据时会返回压缩数据的问题
 

package/dist/middleware.d.ts

@@ -10,9 +10,9 @@ interface CachedMiddlewareOption extends Omit<LockGetOption, 'parse' | 'decompre
 }
 /**
  * 缓存中间件
- * - 缓存中间件缓存的是 ctx.body 最终结果，所以可以缓存任何返回类型
+ * - 缓存中间件缓存的是 `ctx.body` 最终结果，所以可以缓存任何返回类型
  * - 会根据客户端请求头判断是否需要解压
- * @param key 缓存 key 如果不指定则默认使用 ctx.path
+ * @param key 不指定 `key` 则默认使用 `ctx.path`，`key: null` 不适用使用缓存
  */
-export declare function cached(key?: string | ((ctx: Context) => string | Promise<string>), opt?: CachedMiddlewareOption): Middleware;
+export declare function cached(key?: string | null | ((ctx: Context) => string | null | Promise<string | null>), opt?: CachedMiddlewareOption): Middleware;
 export {};

package/dist/middleware.js

@@ -3,15 +3,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.cached = void 0;
 /**
  * 缓存中间件
- * - 缓存中间件缓存的是 ctx.body 最终结果，所以可以缓存任何返回类型
+ * - 缓存中间件缓存的是 `ctx.body` 最终结果，所以可以缓存任何返回类型
  * - 会根据客户端请求头判断是否需要解压
- * @param key 缓存 key 如果不指定则默认使用 ctx.path
+ * @param key 不指定 `key` 则默认使用 `ctx.path`，`key: null` 不适用使用缓存
  */
 function cached(key, opt) {
     return async function cachedMiddleware(ctx, next) {
-        const _key = key ? typeof key === 'string' ? key : await key(ctx) : `CACHED-PATH:${ctx.path}`;
+        const _key = typeof key === 'string' ? key
+            : typeof key === 'function' ? await key(ctx)
+                : typeof key === 'undefined' ? `CACHED-PATH:${ctx.path}`
+                    : null;
+        if (!_key) {
+            return next();
+        }
         const decompress = ctx.acceptsEncodings('gzip') === false;
-        const _opt = Object.assign({}, opt, {
+        const _opt = Object.assign({
+            type: 'json'
+        }, opt, {
             parse: false,
             decompress,
         });
@@ -22,8 +30,8 @@ function cached(key, opt) {
         if (result.compressed) {
             ctx.set('Content-Encoding', 'gzip');
         }
-        if (!ctx.type) {
-            ctx.type = (opt === null || opt === void 0 ? void 0 : opt.type) || 'json';
+        if (_opt.type) {
+            ctx.type = _opt.type;
         }
         ctx.body = result.data;
     };

package/package.json

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