feat: created cacheKeys

Author: tomerh2001

src/index.d.ts

@@ -10,6 +10,6 @@ export type CachedFunctionInitializerOptions =
 	{store: Store};
 
 export type CachedFunctionOptions<F extends AnyFunction> = Partial<CachedFunctionInitializerOptions> & {
-	selector: ArgumentPaths<F>;
+	selector?: ArgumentPaths<F>;
 	ttl?: number;
 };

src/index.ts

@@ -25,6 +25,10 @@ export function resetCache() {
 
 export function selectorToCacheKey<F extends AnyFunction>(arguments_: Parameters<F>, selector: ArgumentPaths<F>) {
 	const selectors = _.castArray(selector);
+	if (selectors.length === 0) {
+		return JSON.stringify(arguments_);
+	}
+
 	const values = selectors.map(path => {
 		const value = _.get(arguments_, path) as unknown;
 		if (value === undefined) {
@@ -43,7 +47,8 @@ export function selectorToCacheKey<F extends AnyFunction>(arguments_: Parameters
 
 export function cachedFunction<F extends AnyFunction>(function_: F, options: CachedFunctionOptions<F>) {
 	return async (...arguments_: Parameters<F>): Promise<ReturnType<F>> => {
-		const cacheKey = selectorToCacheKey(arguments_, options.selector);
+		const selector = options.selector ?? function_.cacheKeys ?? [];
+		const cacheKey = selectorToCacheKey(arguments_, selector);
 		const cache = await getOrInitializeCache(options as CachedFunctionInitializerOptions);
 
 		const cacheValue = await cache.get<ReturnType<F>>(cacheKey);
@@ -57,3 +62,9 @@ export function cachedFunction<F extends AnyFunction>(function_: F, options: Cac
 		return result;
 	};
 }
+
+export function cacheKeys<F extends AnyFunction>(function_: F, ...selector: Array<ArgumentPaths<F>>) {
+	const selectors = _(selector).flatMap().value();
+	function_.cacheKeys = selectors;
+	return function_;
+}

src/paths.d.ts

@@ -13,7 +13,9 @@ export type SingleOrArray<T> = T | T[];
 /**
  * Represents any function that takes any number of arguments and returns any value.
  */
-export type AnyFunction = (...arguments_: any[]) => any;
+export type AnyFunction = ((...arguments_: any[]) => any) & {
+	cacheKeys?: string[];
+};
 
 /**
  * Represents the type for generating paths of a given object.

tests/index.test.ts

@@ -94,7 +94,7 @@ describe('selectorToCacheKey', () => {
 		const selector: any = [];
 		const key = selectorToCacheKey(arguments_, selector);
 
-		expect(key).toBe('{}');
+		expect(key).toBe('[]');
 	});
 
 	it('should throw an error for non-existent paths', () => {
@@ -153,7 +153,7 @@ describe('selectorToCacheKey', () => {
 		const selector: any = [];
 		const key = selectorToCacheKey(arguments_, selector);
 
-		expect(key).toBe('{}');
+		expect(key).toBe(JSON.stringify(arguments_));
 	});
 
 	it('should handle paths that skip levels correctly', () => {