@zenweb/cache 5.0.2 → 5.1.0

package/dist/cache.d.ts

@@ -44,7 +44,7 @@ export declare class Cache {
     /**
      * 直接取得缓存
      */
-    getRaw(key: string): Promise<Buffer | null>;
+    getRaw(key: string): Promise<Buffer<ArrayBufferLike> | null>;
     /**
      * 取得缓存对象
      * @param key 缓存key

package/dist/global.d.ts

@@ -1,3 +1,5 @@
+import { CacheHelperOption } from "./types.js";
+import { CacheHelper } from "./helper.js";
 /**
  * 取得缓存实例
  */
@@ -6,3 +8,7 @@ export declare function $getCache(): import("./cache.js").Cache;
  * 快捷方法 - 缓存实例
  */
 export declare const $cache: import("./cache.js").Cache;
+/**
+ * 快捷方法 - 缓存助手
+ */
+export declare function $cacheHelper<T = unknown>(key: string | (() => string), fetch?: () => Promise<T> | T, opt?: CacheHelperOption): CacheHelper<T>;

package/dist/global.js

@@ -1,4 +1,5 @@
 import { callProxy, $getCore } from "@zenweb/core";
+import { CacheHelper } from "./helper.js";
 /**
  * 取得缓存实例
  */
@@ -10,3 +11,9 @@ export function $getCache() {
  * 快捷方法 - 缓存实例
  */
 export const $cache = callProxy($getCache);
+/**
+ * 快捷方法 - 缓存助手
+ */
+export function $cacheHelper(key, fetch, opt) {
+    return new CacheHelper($getCache(), key, fetch, opt);
+}

package/dist/helper.d.ts

@@ -0,0 +1,27 @@
+import { Cache } from "./cache.js";
+import { CacheHelperOption } from "./types.js";
+export declare class CacheNotExists extends Error {
+}
+export declare class CacheHelper<T = unknown> {
+    private _cache;
+    private _key;
+    private _fetch?;
+    private _opt?;
+    private __key?;
+    constructor(_cache: Cache, _key: string | (() => string), _fetch?: (() => Promise<T> | T) | undefined, _opt?: CacheHelperOption | undefined);
+    private get _cacheKey();
+    /**
+     * 取得缓存
+     *
+     * 如果已定义 `fetch` 参数当缓存不存在时使用 `fetch` 获取并设置缓存，否则抛出异常
+     */
+    get(): Promise<T>;
+    /**
+     * 设置缓存
+     */
+    set(value: T): Promise<import("./types.js").SetResult>;
+    /**
+     * 删除缓存
+     */
+    del(): Promise<number>;
+}

package/dist/helper.js

@@ -0,0 +1,53 @@
+export class CacheNotExists extends Error {
+}
+export class CacheHelper {
+    _cache;
+    _key;
+    _fetch;
+    _opt;
+    __key;
+    constructor(_cache, _key, _fetch, _opt) {
+        this._cache = _cache;
+        this._key = _key;
+        this._fetch = _fetch;
+        this._opt = _opt;
+    }
+    get _cacheKey() {
+        if (!this.__key) {
+            if (typeof this._key === 'function') {
+                this.__key = this._key();
+            }
+            else {
+                this.__key = this._key;
+            }
+        }
+        return this.__key;
+    }
+    /**
+     * 取得缓存
+     *
+     * 如果已定义 `fetch` 参数当缓存不存在时使用 `fetch` 获取并设置缓存，否则抛出异常
+     */
+    async get() {
+        if (typeof this._fetch === 'function') {
+            return this._cache.lockGet(this._cacheKey, this._fetch, { parse: true, noWait: false, ...this._opt });
+        }
+        const data = await this._cache.get(this._cacheKey, { parse: true, ...this._opt });
+        if (data === undefined) {
+            throw new CacheNotExists(`cache not exists: ${this._cacheKey}`);
+        }
+        return data;
+    }
+    /**
+     * 设置缓存
+     */
+    set(value) {
+        return this._cache.set(this._cacheKey, value, this._opt);
+    }
+    /**
+     * 删除缓存
+     */
+    del() {
+        return this._cache.del(this._cacheKey);
+    }
+}

package/dist/index.d.ts

@@ -7,6 +7,7 @@ export * from './types.js';
 export * from './utils.js';
 export { Locker } from './locker.js';
 export { cached } from './middleware.js';
+export { CacheHelper } from './helper.js';
 export { Cache };
 /**
  * 安装模块

package/dist/index.js

@@ -6,6 +6,7 @@ export * from './types.js';
 export * from './utils.js';
 export { Locker } from './locker.js';
 export { cached } from './middleware.js';
+export { CacheHelper } from './helper.js';
 export { Cache };
 /**
  * 安装模块

package/dist/types.d.ts

@@ -145,3 +145,4 @@ export interface LockGetOption extends GetOption, SetOption, LockOption {
      */
     noWait?: boolean;
 }
+export type CacheHelperOption = Omit<LockGetOption, 'parse' | 'noWait'>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zenweb/cache",
   "type": "module",
-  "version": "5.0.2",
+  "version": "5.1.0",
   "description": "Zenweb Cache module",
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",