chore: use custom error class for navigation

Author: richardjelinek-fastest

src/create-router.svelte.js

@@ -4,6 +4,7 @@ import { matchRoute } from './helpers/match-route.js';
 import { preload, preloadOnHover } from './helpers/preload.js';
 import { constructPath, join, resolveRouteComponents, updatedLocation } from './helpers/utils.js';
 import { syncSearchParams } from './search-params.svelte.js';
+import { Navigation } from './navigation.js';
 
 /** @type {import('./index.d.ts').Routes} */
 let routes;
@@ -86,7 +87,7 @@ export function createRouter(r) {
 function navigate(path, options = {}) {
 	if (typeof path === 'number') {
 		globalThis.history.go(path);
-		return new Error(`Navigating to history entry: ${path}`);
+		return new Navigation(`History entry: ${path}`);
 	}
 	if (options.params) {
 		path = constructPath(path, options.params);
@@ -98,7 +99,7 @@ function navigate(path, options = {}) {
 		options.hash = '#' + options.hash;
 	}
 	onNavigate(path, options);
-	return new Error(`Navigating to: ${path}${options?.search ?? ''}${options?.hash ?? ''}`);
+	return new Navigation(`${path}${options?.search ?? ''}${options?.hash ?? ''}`);
 }
 
 /**

src/index.d.ts

@@ -96,6 +96,10 @@ export type IsActiveLink = Action<
 // eslint-disable-next-line @typescript-eslint/no-empty-object-type
 export interface RouteMeta {}
 
+export class Navigation extends Error {
+	constructor(target: string);
+}
+
 export type RouterApi<T extends Routes> = {
 	/**
 	 * Construct a path while ensuring type safety.

src/index.js

@@ -2,3 +2,4 @@ export { isActiveLink } from './actions.svelte.js';
 export { createRouter } from './create-router.svelte.js';
 export { default as Router } from './Router.svelte';
 export { searchParams } from './search-params.svelte.js';
+export { Navigation } from 'navigation.js';

src/navigation.js

@@ -0,0 +1,9 @@
+export class Navigation extends Error {
+	constructor(
+		/** @type {string} target */
+		target,
+	) {
+		super(`Navigating to: ${target}`);
+		this.name = 'Redirect';
+	}
+}