feat: added noCache to options

Author: tomerh2001

bun.lockb

@@ -17,7 +17,7 @@
     "xo": "^0.59.3"
   },
   "peerDependencies": {
-    "typescript": "^5.5.4"
+    "typescript": "^5.6.2"
   },
   "scripts": {
     "build": "tsc",
@@ -26,7 +26,7 @@
   },
   "dependencies": {
     "cache-manager": "^5.7.6",
-    "eslint-plugin-th-rules": "^1.13.4",
+    "eslint-plugin-th-rules": "^1.14.0",
     "lodash": "^4.17.21",
     "reflect-metadata": "^0.2.2"
   },

package.json

@@ -65,7 +65,12 @@ export type CachedFunctionInitializerOptions = {logger?: Partial<Logger>;} &
  * @property {boolean} [force] - Whether to force the execution of the cached function.
  */
 export type CachedFunctionOptions<F extends CacheableFunction> = Partial<CachedFunctionInitializerOptions> & {
+	/** The selector for the cached function. */
 	selector?: ArgumentPaths<F>;
+	/** The time-to-live (TTL) for the cached function. */
 	ttl?: number;
+	/** Whether to force update the cache. */
 	force?: boolean;
+	/** Don't use the cache at all - when `true`, calls to functions wrapped by `cachedFunction` will essentially just call the original function. */
+	noCache?: boolean;
 };

src/index.d.ts

@@ -41,7 +41,7 @@ export async function getOrInitializeCache<S extends Store>(options?: CachedFunc
 		logger = options.logger as Logger;
 	}
 
-	logger?.trace({options}, 'Initializing cache');
+	logger?.trace('Initializing cache');
 	cache ||= await ('config' in options! ? caching(options.store, options.config) : caching(options!.store));
 	logger?.trace('Cache initialized');
 
@@ -105,21 +105,26 @@ export function cachedFunction<F extends CacheableFunction>(function_: F, option
 			throw new Error('No cache options provided, either use the @CacheOptions decorator or provide options to cachedFunction directly.');
 		}
 
+		if (!cacheOptions.noCache) {
+			logger.trace('Cache is disabled, calling the original function directly');
+			return function_(...arguments_) as ReturnType<F>;
+		}
+
 		const cacheKey = selectorToCacheKey(arguments_, cacheOptions.selector!);
 		const cache = await getOrInitializeCache(options as CachedFunctionInitializerOptions);
 
-		logger?.trace({cacheOptions, cacheKey}, 'Checking cache');
+		logger?.trace({cacheKey}, 'Checking cache');
 		const cacheValue = await cache.get<ReturnType<F>>(cacheKey);
 		if (!cacheOptions.force && cacheValue !== undefined) {
-			logger?.trace({cacheOptions, cacheKey}, 'Cache hit');
+			logger?.trace({cacheKey}, 'Cache hit');
 			return cacheValue;
 		}
-		logger?.trace({cacheOptions, cacheKey}, 'Cache miss');
+		logger?.trace({cacheKey}, 'Cache miss');
 
 		const result = await function_(...arguments_) as ReturnType<F>;
-		logger?.trace({cacheOptions, cacheKey}, 'Setting cache');
+		logger?.trace({cacheKey}, 'Setting cache');
 		await cache.set(cacheKey, result, cacheOptions.ttl);
-		logger?.trace({cacheOptions, cacheKey}, 'Cache set');
+		logger?.trace({cacheKey}, 'Cache set');
 
 		return result;
 	};
@@ -169,8 +174,6 @@ export function CacheOptions<F extends CacheableFunction>(
 		}
 
 		descriptor.value.cacheOptions = options;
-		logger?.trace({options}, 'Cache options set');
-		
 		return descriptor;
 	};
 }

src/index.ts

@@ -2,6 +2,7 @@
 import {random} from 'lodash';
 import {type RedisStore, redisStore} from 'cache-manager-ioredis-yet';
 import {cachedFunction, CacheOptions, getOrInitializeCache} from '../src';
+import { selectorToCacheKey } from '../src/index';
 
 const cache = await getOrInitializeCache<RedisStore>({
 	store: await redisStore({
@@ -22,14 +23,14 @@ type Person = {
 };
 
 class CachedPersonCreator {
-	@CacheOptions('0.name', 10_000)
+	@CacheOptions({ttl: 10_000})
 	static async createPerson(person: Person) {
 		console.log('Person created!!!!!');
 		return person;
 	}
 }
 
-const cachedCreatePerson = cachedFunction(CachedPersonCreator.createPerson);
+const cachedCreatePerson = cachedFunction(CachedPersonCreator.createPerson, {ttl: -2345, selector: ['0.name']});
 const person = await cachedCreatePerson({
 	id: random(0, 100_000).toString(),
 	name: 'Tomer Horowitz',