docs

Author: omerman

packages/docs/src/routes/api/qwik/api.json

@@ -1774,7 +1774,7 @@
         }
       ],
       "kind": "Function",
-      "content": "> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.\n> \n\n> Warning: This API is now obsolete.\n> \n> This is no longer needed as the preloading happens automatically in qrl-class.ts. Leave this in your app for a while so it uninstalls existing service workers, but don't use it for new projects.\n> \n\n\n```typescript\nPrefetchServiceWorker: (opts: {\n    base?: string;\n    scope?: string;\n    path?: string;\n    verbose?: boolean;\n    fetchBundleGraph?: boolean;\n    nonce?: string;\n}) => JSXNode<'script'>\n```\n\n\n<table><thead><tr><th>\n\nParameter\n\n\n</th><th>\n\nType\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\nopts\n\n\n</td><td>\n\n{ base?: string; scope?: string; path?: string; verbose?: boolean; fetchBundleGraph?: boolean; nonce?: string; }\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\n[JSXNode](#jsxnode)<!-- -->&lt;'script'&gt;",
+      "content": "> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.\n> \n\n> Warning: This API is now obsolete.\n> \n> This is no longer needed as the preloading happens automatically in qrl-class.ts. Leave this in your app for a while so it uninstalls existing service workers, but don't use it for new projects.\n> \n\n\n```typescript\nPrefetchServiceWorker: (opts: {\n    base?: string;\n    scope?: string;\n    path?: string;\n    verbose?: boolean;\n    fetchBundleGraph?: boolean;\n    nonce?: string;\n}) => JSXNode<'script'>\n```\n\n\n<table><thead><tr><th>\n\nParameter\n\n\n</th><th>\n\nType\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\nopts\n\n\n</td><td>\n\n{ base?: string; scope?: string; path?: string; verbose?: boolean; fetchBundleGraph?: boolean; nonce?: string; }\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\nJSXNode&lt;'script'&gt;",
       "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/components/prefetch.ts",
       "mdFile": "qwik.prefetchserviceworker.md"
     },

packages/docs/src/routes/api/qwik/index.mdx

@@ -3651,7 +3651,7 @@ opts
 </tbody></table>
 **Returns:**
 
-[JSXNode](#jsxnode)&lt;'script'&gt;
+JSXNode&lt;'script'&gt;
 
 [Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/components/prefetch.ts)
 

packages/docs/src/routes/docs/(qwikcity)/guides/rewrites/index.mdx

@@ -0,0 +1,48 @@
+---
+title: Rewrites | Guides
+description: Learn how to use rewrites in Qwik City.
+contributors:
+  - omerman
+updated_at: '2025-05-04T19:43:33Z'
+created_at: '2025-05-04T23:45:13Z'
+---
+
+# Rewrites
+
+Sometimes you want to redirect a user from the current page to another page,
+but you want to keep the current URL in the browser history.
+
+Let's say a user tries to access an article which is indexed by its name,
+e.g `/articles/qwik-is-very-quick`.
+but in our code, we access it by its id, on our directory structure.
+
+```
+src/routes/articles/
+├── [id]
+├─── index.tsx
+```
+
+
+```tsx title="src/routes/[email protected]"
+import type { RequestHandler } from "@builder.io/qwik-city";
+
+export const onRequest: RequestHandler = async ({ url, rewrite }) => {
+  const pattern = /^\/articles\/(.*)$/;
+  // Detects /articles/<article-name>, returns null if url does not match the pattern.
+  const match = url.pathname.match(pattern);
+  if (match) {
+    const articleName = match[1];
+    const { id } = await db.getArticleByName(articleName);
+    throw rewrite(`/articles/${id}`);
+  }
+};
+```
+
+The `rewrite()` function, which was destructured in the RequestHandler function arguments, takes a pathname string or a URL object.
+
+```tsx
+throw rewrite(`/articles/777/`);
+throw rewrite(new URL(`/articles/777/`, url));
+```
+
+Note: If you provide a relative path, Qwik City will rewrite the URL and apply search params from the original URL.