@resolid/cache 1.0.1 → 1.2.0

package/README.md

@@ -12,7 +12,7 @@ Designed for libraries, frameworks, and applications needing predictable async c
 ## Feature
 
 - Fully typed with TypeScript — no `any`.
-- Supports get/set/del/clear operations.
+- Supports get/getOrSet/set/del/clear operations.
 - Supports batch operations: getMultiple, setMultiple, delMultiple.
 - Optional TTL for automatic expiration.
 - Pluggable store backend (default is `nullCache`).
@@ -42,6 +42,9 @@ const cache = new Cacher({ defaultTtl: 1000 });
 await cache.set("foo", { a: 1 });
 const value = await cache.get("foo"); // -> { a: 1 }
 
+// Get or set with factory
+const user = await cache.getOrSet("user:1", () => fetchUser(1), 60);
+
 // Check existence
 const exists = await cache.has("foo"); // -> true
 
@@ -65,6 +68,11 @@ await cache.dispose();
 ```ts
 export interface CacheOptions {
   store?: CacheStore;
+
+  // A custom serializer to use when storing and retrieving values from the cache.
+  // For example, you could use superjson to serialize and deserialize your values instead of JSON.stringify and JSON.parse.
+  serializer?: Serializer;
+
   defaultTtl?: number;
 }
 ```

package/dist/index.d.mts

@@ -1,19 +1,27 @@
 import { t as CacheStore } from "./types-BvLwqpdf.mjs";
 
 //#region src/index.d.ts
+type Serializer = {
+  serialize: <T = unknown>(value: T) => string;
+  deserialize: <T = unknown>(value: string) => T;
+};
 interface CacheOptions {
   store?: CacheStore;
+  serializer?: Serializer;
   defaultTtl?: number;
 }
 declare class Cacher {
   private readonly _store;
+  private readonly _serializer;
   private readonly _defaultTtl?;
   constructor({
     store,
+    serializer,
     defaultTtl
   }?: CacheOptions);
   get<T>(key: string, defaultValue?: T): Promise<T | undefined>;
   set<T>(key: string, value: T, ttl?: number): Promise<boolean>;
+  getOrSet<T>(key: string, factory: () => T | Promise<T>, ttl?: number): Promise<T>;
   del(key: string): Promise<boolean>;
   clear(): Promise<boolean>;
   getMultiple<T>(keys: string[], defaultValue?: T): Promise<(T | undefined)[]>;

package/dist/index.mjs

@@ -1 +1 @@
-import{t as e}from"./null-cache-DGPituGm.mjs";import{destr as t}from"destr";const n=e=>{let t=e.split(`?`)[0]?.replace(/[/\\]/g,`:`).replace(/:+/g,`:`).replace(/^:|:$/g,``);if(!t)throw Error(`Cache key cannot be empty after normalization`);return t};var r=class{_store;_defaultTtl;constructor({store:t=new e,defaultTtl:n}={}){this._store=t,this._defaultTtl=n}async get(e,r){let i=await this._store.get(n(e));return i===void 0?r:t(i)}set(e,t,r){return this._store.set(n(e),JSON.stringify(t),r??this._defaultTtl)}del(e){return this._store.del(n(e))}clear(){return this._store.clear()}async getMultiple(e,r){return this._store.getMultiple?(await this._store.getMultiple(e.map(n))).map(e=>e===void 0?r:t(e)):Promise.all(e.map(e=>this.get(e,r)))}async setMultiple(e,t){if(this._store.setMultiple){let r=Object.entries(e).reduce((e,[t,r])=>(e[n(t)]=JSON.stringify(r),e),{});return this._store.setMultiple(r,t)}return(await Promise.all(Object.entries(e).map(([e,n])=>this.set(e,n,t)))).every(Boolean)}async delMultiple(e){return this._store.delMultiple?this._store.delMultiple(e.map(n)):(await Promise.all(e.map(e=>this.del(e)))).every(Boolean)}async has(e){return this._store.has?this._store.has(n(e)):await this.get(e)!==void 0}async dispose(){await this._store.dispose?.()}};export{r as Cacher};
+import{t as e}from"./null-cache-DGPituGm.mjs";function t(e){let t=e.split(`?`)[0]?.replace(/[/\\]/g,`:`).replace(/:+/g,`:`).replace(/^:|:$/g,``);if(!t)throw Error(`Cache key cannot be empty after normalization`);return t}var n=class{_store;_serializer;_defaultTtl;constructor({store:t=new e,serializer:n={serialize:JSON.stringify,deserialize:JSON.parse},defaultTtl:r}={}){this._store=t,this._serializer=n,this._defaultTtl=r}async get(e,n){let r=await this._store.get(t(e));return r===void 0?n:this._serializer.deserialize(r)}set(e,n,r){return this._store.set(t(e),this._serializer.serialize(n),r??this._defaultTtl)}async getOrSet(e,t,n){let r=await this.get(e);if(r!==void 0)return r;let i=await t();return await this.set(e,i,n),i}del(e){return this._store.del(t(e))}clear(){return this._store.clear()}async getMultiple(e,n){return this._store.getMultiple?(await this._store.getMultiple(e.map(t))).map(e=>e===void 0?n:this._serializer.deserialize(e)):Promise.all(e.map(e=>this.get(e,n)))}async setMultiple(e,n){return this._store.setMultiple?this._store.setMultiple(Object.entries(e).reduce((e,[n,r])=>(e[t(n)]=this._serializer.serialize(r),e),{}),n):(await Promise.all(Object.entries(e).map(([e,t])=>this.set(e,t,n)))).every(Boolean)}async delMultiple(e){return this._store.delMultiple?this._store.delMultiple(e.map(t)):(await Promise.all(e.map(e=>this.del(e)))).every(Boolean)}async has(e){return this._store.has?this._store.has(t(e)):await this.get(e)!==void 0}async dispose(){await this._store.dispose?.()}};export{n as Cacher};

package/dist/stores.d.mts

@@ -24,4 +24,4 @@ declare class NullCache implements Required<CacheStore> {
   dispose(): Promise<void>;
 }
 //#endregion
-export { CacheStore, MemoryCache, NullCache };
+export { type CacheStore, MemoryCache, NullCache };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@resolid/cache",
-  "version": "1.0.1",
+  "version": "1.2.0",
   "private": false,
   "description": "Type-safe Async Cache for TypeScript",
   "keywords": [
@@ -41,11 +41,10 @@
     "provenance": true
   },
   "dependencies": {
-    "destr": "^2.0.5",
     "quick-lru": "^7.3.0"
   },
   "devDependencies": {
-    "tsdown": "^0.21.5"
+    "tsdown": "^0.22.0"
   },
   "engines": {
     "node": "^22.13.0 || >=24"