Add custom transformer options (#503)

Author: A-J Roos

README.md

@@ -200,6 +200,27 @@ Options:
       });
       ```
 
+- `transformer`: (optional) the transformer to used to serialize and deserialize the cache entries. It must be an object
+  with the following methods:
+
+  - `serialize`: a function that receives the result of the original function and returns a serializable object.
+  - `deserialize`: a function that receives the serialized object and returns the original result.
+
+  - Default is `undefined`, so the default transformer is used.
+
+    Example
+
+    ```js
+    import superjson from "superjson";
+
+    createPrismaRedisCache({
+      transformer: {
+        serialize: (result) => superjson.serialize(result),
+        deserialize: (serialized) => superjson.deserialize(serialized),
+      },
+    });
+    ```
+
 ## Debugging
 
 You can pass functions for `onMiss`, `onHit`, `onError` and `onDedupe` to `createPrismaRedisCache` which can then be

src/index.ts

@@ -24,6 +24,7 @@ export const createPrismaRedisCache = ({
   cacheTime = DEFAULT_CACHE_TIME,
   excludeModels = [],
   excludeMethods = [],
+  transformer,
 }: CreatePrismaRedisCache) => {
   // Default options for "async-cache-dedupe"
   const cacheOptions = {
@@ -33,6 +34,7 @@ export const createPrismaRedisCache = ({
     onMiss,
     storage,
     ttl: cacheTime,
+    transformer,
   };
 
   const cache: any = createCache(cacheOptions);

src/types.ts

@@ -85,4 +85,8 @@ export type CreatePrismaRedisCache = {
   onHit?: (key: string) => void;
   onMiss?: (key: string) => void;
   onDedupe?: (key: string) => void;
+  transformer?: {
+    serialize: (data: any) => any;
+    deserialize: (data: any) => any;
+  };
 };