feat: Rename clearCache to refresh

BREAKING CHANGE: clearCache is now called refresh

Author: jantimon

README.md

@@ -171,7 +171,7 @@ can be used to rerender outdated components
 
 ```ts
 const userLoader = createGetEndpoint(...)
-userLoader.clearCache()
+userLoader.refresh()
 ```
 
 ## Disabling Cache
@@ -209,7 +209,7 @@ const getUserName = createGetEndpoint({
 })
 const setUserName = createPostEndpoint({
     url: keys => `http://example.com/user/${keys.id}/update`,
-    afterSuccess: () => getUserName.clearCache();
+    afterSuccess: () => getUserName.refresh();
 })
 ```
 
@@ -290,7 +290,7 @@ const userEndpoint = createGetEndpoint<Input, Output>({
 
 ## Endpoint observing
 
-Invalidating the cache using `clearCache` will internaly trigger a clearCache event.  
+Invalidating the cache using `refresh` will internaly trigger a refresh event.  
 To subscribe to the initial data load and updates after a clear cache it is possible to observe an endpoint:
 
 ```js

core/README.md

@@ -171,7 +171,7 @@ can be used to rerender outdated components
 
 ```ts
 const userLoader = createGetEndpoint(...)
-userLoader.clearCache()
+userLoader.refresh()
 ```
 
 ## Disabling Cache
@@ -209,7 +209,7 @@ const getUserName = createGetEndpoint({
 })
 const setUserName = createPostEndpoint({
     url: keys => `http://example.com/user/${keys.id}/update`,
-    afterSuccess: () => getUserName.clearCache();
+    afterSuccess: () => getUserName.refresh();
 })
 ```
 
@@ -290,7 +290,7 @@ const userEndpoint = createGetEndpoint<Input, Output>({
 
 ## Endpoint observing
 
-Invalidating the cache using `clearCache` will internaly trigger a clearCache event.  
+Invalidating the cache using `refresh` will internaly trigger a refresh event.  
 To subscribe to the initial data load and updates after a clear cache it is possible to observe an endpoint:
 
 ```js

core/src/index.ts

@@ -74,7 +74,7 @@ export interface EndpointGetFunction<TKeys extends {}, TResult extends unknown>
 	/**
 	 * Clear the cache for this url
 	 */
-	clearCache: () => void;
+	refresh: () => void;
 	/**
 	 * Cache Key
 	 */

core/src/lib/CacheStore.ts

@@ -17,14 +17,14 @@ export interface CacheStore<TKeys, TResult> {
 	/**
 	 * Clear the cache for this url
 	 */
-	clearCache: () => void;
+	refresh: () => void;
 	/**
 	 * Cache Key
 	 */
 	getCacheKey: (keys: TKeys) => string;
 	/**
 	 * The time of the first write into the cache
-	 * will be reset on clearCache
+	 * will be reset on refresh
 	 */
 	_state: { _cacheCreation?: Date };
 	/**
@@ -135,14 +135,14 @@ export function createCacheStore<
 			callback: (result: Promise<TResult>) => any,
 			timeout?: number
 		) => () => void;
-		clearCache: () => Promise<any[]>;
+		refresh: () => Promise<any[]>;
 	} = {
 		cache,
 		_state: cacheState,
 		getCacheKey: cacheKeyGenerator
 			? keys => cacheKeyGenerator(keys, getUrlCacheKey(keys))
 			: getUrlCacheKey,
-		clearCache: () => {
+		refresh: () => {
 			const previousCacheCreation = cacheState._cacheCreation;
 			let cacheClearHandlers: Array<Promise<any> | void> = [];
 			if (previousCacheCreation) {

core/test/index.test.ts

@@ -205,7 +205,7 @@ test("should allow to use observePromise to obtain the endpoints value", async (
 	// Get first value
 	expect(await latestPromise).toEqual({ run: 0 });
 	// Clear cache
-	runCountEndpoint.clearCache();
+	runCountEndpoint.refresh();
 	jest.runAllTimers();
 	// Verify that the value is not comming from cache
 	expect(await latestPromise).toEqual({ run: 1 });
@@ -236,7 +236,7 @@ test("should allow to use observe to obtain the endpoints value", async () => {
 	expect(latestValue).toEqual({ run: 0 });
 	nextChangePromise = createDeferred();
 	// Clear cache
-	runCountEndpoint.clearCache();
+	runCountEndpoint.refresh();
 	jest.runAllTimers();
 	// Verify that the value is not comming from cache
 	await nextChangePromise;

utils/request-registry-mobx/test/index.test.ts

@@ -191,7 +191,7 @@ describe('request-registry-mobx', () => {
 			await when(() => endpoint.state === 'DONE');
 			expect(endpoint.value).toEqual({ runs: 1 });
 			// Invalidate the cache:
-			runEndpoint.clearCache();
+			runEndpoint.refresh();
 			// Wait for a new run count
 			await when(() =>
 				Boolean(endpoint.value && endpoint.value.runs !== 1)
@@ -212,7 +212,7 @@ describe('request-registry-mobx', () => {
 			// Start observing the endpoint:
 			const unobserve = autorun(() => endpoint.value);
 			// Invalidate the cache:
-			runEndpoint.clearCache();
+			runEndpoint.refresh();
 			expect(endpoint.busy).toEqual(true);
 			unobserve();
 		});

utils/request-registry-mock/README.md

@@ -70,7 +70,7 @@ The `mockEndpointOnce` is similar to `mockEndpoint` however it will unbind after
 const userEndpoint = createGetEndpoint({ url: () => '/user' });
 mockEndpointOnce(getUserName, async () => ({ name: 'Joe' }));
 console.log(await userEndpoint()); // Will return the mocked value `{name: 'Joe'}`
-userEndpoint.clearCache();
+userEndpoint.refresh();
 console.log(await userEndpoint()); // Will return the value of an unmocked call`
 ```
 

utils/request-registry-mock/test/index.test.ts

@@ -130,7 +130,7 @@ describe('request-registry-mock', () => {
 			userEndpointMock1.activate();
 			userEndpointMock2.activate();
 			expect(await userEndpoint({})).toEqual({ name: 'Chris' });
-			userEndpoint.clearCache();
+			userEndpoint.refresh();
 			userEndpointMock2.clear();
 			expect(await userEndpoint({})).toEqual({ name: 'Alex' });
 		});
@@ -155,7 +155,7 @@ describe('request-registry-mock', () => {
 			userEndpointMock1.activate();
 			userEndpointMock2.activate();
 			expect(await userEndpoint({})).toEqual({ name: 'Chris' });
-			userEndpoint.clearCache();
+			userEndpoint.refresh();
 			userEndpointMock1.clear();
 			expect(await userEndpoint({})).toEqual({ name: 'Chris' });
 			userEndpointMock2.clear();
@@ -171,7 +171,7 @@ describe('request-registry-mock', () => {
 			mockEndpointOnce(userEndpoint, async () => ({ name: 'Alex' }));
 			mockEndpointOnce(userEndpoint, async () => ({ name: 'Chris' }));
 			expect(await userEndpoint({})).toEqual({ name: 'Chris' });
-			userEndpoint.clearCache();
+			userEndpoint.refresh();
 			expect(await userEndpoint({})).toEqual({ name: 'Alex' });
 		});
 	});
@@ -196,7 +196,7 @@ describe('request-registry-mock', () => {
 			activateMocks(userEndpointMock1, userEndpointMock2);
 			expect(await userEndpoint({})).toEqual({ name: 'Chris' });
 			userEndpointMock2.clear();
-			userEndpoint.clearCache();
+			userEndpoint.refresh();
 			expect(await userEndpoint({})).toEqual({ name: 'Alex' });
 		});
 	});

utils/request-registry-react/example/endpoints.tsx

@@ -21,10 +21,10 @@ export const loginEndpoint = createPostEndpoint<
 	{}
 >({
 	url: () => `/user/login`,
-	afterSuccess: () => productsEndpoint.clearCache()
+	afterSuccess: () => productsEndpoint.refresh()
 });
 
 export const logoutEndpoint = createPostEndpoint<{}, {}, {}>({
 	url: () => `/user/logout`,
-	afterSuccess: () => productsEndpoint.clearCache()
+	afterSuccess: () => productsEndpoint.refresh()
 });

utils/request-registry-react/test/index.test.tsx

@@ -74,7 +74,7 @@ describe("request-registry-react", () => {
 			const { container } = render(<Runs />);
 			await wait();
 			expect(container.innerHTML).toEqual("<div>0</div>");
-			runsEndpoint.clearCache();
+			runsEndpoint.refresh();
 			await wait();
 			expect(container.innerHTML).toEqual("<div>1</div>");
 		});
@@ -108,7 +108,7 @@ describe("request-registry-react", () => {
 				async () => ({ name: "Fast", age: 1 }),
 				1
 			);
-			userEndpoint.clearCache();
+			userEndpoint.refresh();
 			// Execute fast request
 			await userEndpoint({ id: "4" });
 			await slowRequest;