feat: Suport for the replace parameter in useLocation().route (#8)

Co-authored-by: Ryan Christian <[email protected]>

Author: rxliuli

src/router.d.ts

@@ -13,7 +13,7 @@ interface LocationHook {
 	url: string;
 	path: string;
 	query: Record<string, string>;
-	route: (url: string) => void;
+	route: (url: string, replace?: boolean) => void;
 }
 export const useLocation: () => LocationHook;
 

src/router.js

@@ -25,6 +25,9 @@ const UPDATE = (state, url) => {
 		url = link.href.replace(location.origin, '');
 	} else if (typeof url === 'string') {
 		push = true;
+	} else if (url && url.url) {
+		push = !url.replace;
+		url = url.url;
 	} else {
 		url = location.pathname + location.search;
 	}
@@ -69,7 +72,13 @@ export function LocationProvider(props) {
 		const u = new URL(url, location.origin);
 		const path = u.pathname.replace(/(.)\/$/g, '$1');
 		// @ts-ignore-next
-		return { url, path, query: Object.fromEntries(u.searchParams), route, wasPush };
+		return {
+			url,
+			path,
+			query: Object.fromEntries(u.searchParams),
+			route: (url, replace) => route({ url, replace }),
+			wasPush
+		};
 	}, [url]);
 
 	useLayoutEffect(() => {

test/router.test.js

@@ -504,4 +504,32 @@ describe('Router', () => {
 		await sleep(20);
 		expect(params).toMatchObject({ id: 'bar' });
 	});
+
+	it('should replace the current URL', async () => {
+		const pushState = jest.spyOn(history, 'pushState');
+		const replaceState = jest.spyOn(history, 'replaceState');
+		let loc;
+
+		render(
+			html`
+				<${LocationProvider}>
+					<${Router}>
+						<${Route} path="/foo" component=${() => null} />
+					<//>
+					<${() => {
+						loc = useLocation();
+					}} />
+				<//>
+			`,
+			scratch
+		);
+
+		await sleep(20);
+		loc.route("/foo", true);
+		expect(pushState).not.toHaveBeenCalled();
+		expect(replaceState).toHaveBeenCalledWith(null, "", "/foo");
+
+		pushState.mockRestore();
+		replaceState.mockRestore();
+	});
 });