fix: pass parameters into onNavigate in Router.svelte

Author: richardjelinek-fastest

.changeset/hot-pugs-worry.md

@@ -0,0 +1,5 @@
+---
+'sv-router': patch
+---
+
+pass initial page pathname, search, hash to onNavigate, correctly handle cancellation of navigations, return Error in navigate

src/create-router.svelte.js

@@ -114,11 +114,12 @@ export function createRouter(r) {
  * 	params?: Record<string, string>;
  * 	search?: import('./index.d.ts').Search;
  * }} options
+ * @returns Promise<Error>
  */
 function navigate(path, options = {}) {
 	if (typeof path === 'number') {
 		globalThis.history.go(path);
-		return;
+		return new Error(`Navigating to history entry: ${path}`);
 	}
 
 	path = constructPath(path, options.params);
@@ -128,10 +129,11 @@ function navigate(path, options = {}) {
 		options.hash = '#' + options.hash;
 	}
 	onNavigate(path, options);
+	return new Error(`Navigating to: ${path}${options?.search ?? ''}${options?.hash ?? ''}`);
 }
 
 /**
- * @param {string} [path]
+ * @param {string} path
  * @param {import('./index.d.ts').NavigateOptions} options
  */
 export async function onNavigate(path, options = {}) {
@@ -253,7 +255,7 @@ export function onGlobalClick(event) {
 
 	event.preventDefault();
 	const { replace, state, scrollToTop, viewTransition } = anchor.dataset;
-	onNavigate(path, {
+	void onNavigate(path, {
 		replace: replace === '' || replace === 'true',
 		search: url.search,
 		state,

src/index.d.ts

@@ -139,8 +139,10 @@ export type RouterApi<T extends Routes> = {
 	 *
 	 * @param route The route to navigate to.
 	 * @param options The navigation options.
+	 *
+	 *   Returns an Error for use with `throw navigate(...)` inside hooks.
 	 */
-	navigate<U extends Path<T>>(...args: NavigateArgs<U>): void;
+	navigate<U extends Path<T>>(...args: NavigateArgs<U>): Error;
 
 	/**
 	 * Will return `true` if the given path is active.