feat(core): Handover cache information to cacheInvalidation method

Author: jantimon

core/src/index.ts

@@ -32,9 +32,12 @@ export interface EndpointGetOptions<TKeys, TResult, TKeysBind = TKeys>
 	/**
 	 * A function which returns false if the cache is invalid
 	 *
-	 * TODO: Change to cacheValidator(api, cacheKey, keys) ?
 	 */
 	cacheValidator?: (
+		url: string,
+		headers: { [keys: string]: string },
+		cacheKey: string,
+		cache: Cache<TResult>,
 		api: EndpointWithoutRequestBodyFunction<TKeysBind, TResult, "GET">
 	) => boolean;
 	/**

core/src/lib/CacheStore.ts

@@ -1,7 +1,4 @@
-import {
-	EndpointHeadersTemplate,
-	EndpointWithoutRequestBodyFunction
-} from "./Endpoint";
+import { EndpointHeadersTemplate } from "./Endpoint";
 import { Emitter } from "./Emitter";
 
 export interface Cache<TResult> {
@@ -73,11 +70,13 @@ export interface EndpointCacheOptions<
 	cache?: Cache<TResult>;
 	/**
 	 * A function which returns false if the cache is invalid
-	 *
-	 * TODO: Change to cacheValidator(api, cacheKey, keys) ?
 	 */
 	cacheValidator?: (
-		api: EndpointWithoutRequestBodyFunction<TKeysBind, TResult, "GET">
+		url: string,
+		headers: { [keys: string]: string },
+		cacheKey: string,
+		cache: Cache<TResult>,
+		api: any
 	) => boolean;
 }
 

core/src/lib/Endpoint.ts

@@ -163,7 +163,14 @@ export function createEndpoint<
 				cacheKey = getCacheKey(url, headers);
 				// Check if cache is still valid
 				const skipCache =
-					cacheValidator && cacheValidator(api as any) === false;
+					cacheValidator &&
+					cacheValidator(
+						url.value,
+						headers.value,
+						cacheKey,
+						cache,
+						api as any
+					) === false;
 				if (cacheKey && !skipCache) {
 					const ajaxResultFromCache = cache!.get(cacheKey);
 					if (ajaxResultFromCache) {