docs: tell people to avoid goto(external)

Rich-Harris · web-flow · commit 02bd767d3277 · 2023-02-03T11:43:00.000+01:00
related to #8775
diff --git a/.changeset/loud-pans-fly.md b/.changeset/loud-pans-fly.md
@@ -0,0 +1,5 @@
+---
+'@sveltejs/kit': patch
+---
+
+docs: discourage use of `goto` with external URLs
diff --git a/packages/kit/types/ambient.d.ts b/packages/kit/types/ambient.d.ts
@@ -170,6 +170,7 @@ declare module '$app/navigation' {
 	export function disableScrollHandling(): void;
 	/**
 	 * Returns a Promise that resolves when SvelteKit navigates (or fails to navigate, in which case the promise rejects) to the specified `url`.
+	 * For external URLs, use `window.location = url` instead of calling `goto(url)`.
 	 *
 	 * @param url Where to navigate to. Note that if you've set [`config.kit.paths.base`](https://kit.svelte.dev/docs/configuration#paths) and the URL is root-relative, you need to prepend the base path if you want to navigate within the app.
 	 * @param opts Options related to the navigation

Original file line number	Diff line number	Diff line change
`@@ -170,6 +170,7 @@ declare module '$app/navigation' {`
`170`	`170`	`export function disableScrollHandling(): void;`
`171`	`171`	`/**`
`172`	`172`	* Returns a Promise that resolves when SvelteKit navigates (or fails to navigate, in which case the promise rejects) to the specified `url`.
	`173`	+ * For external URLs, use `window.location = url` instead of calling `goto(url)`.
`173`	`174`	`*`
`174`	`175`	* @param url Where to navigate to. Note that if you've set [`config.kit.paths.base`](https://kit.svelte.dev/docs/configuration#paths) and the URL is root-relative, you need to prepend the base path if you want to navigate within the app.
`175`	`176`	`* @param opts Options related to the navigation`