diff --git a/apps/content/.vitepress/config.ts b/apps/content/.vitepress/config.ts index bc214bed4..85308e3c2 100644 --- a/apps/content/.vitepress/config.ts +++ b/apps/content/.vitepress/config.ts @@ -88,30 +88,24 @@ export default defineConfig({ { text: 'HTTP', link: '/docs/adapters/http' }, { text: 'Websocket', link: '/docs/adapters/websocket' }, { text: 'Message Port', link: '/docs/adapters/message-port' }, + { text: '---' }, + { text: 'Astro', link: '/docs/adapters/astro' }, + { text: 'Browser', link: '/docs/adapters/browser' }, + { text: 'Electron', link: '/docs/adapters/electron' }, + { text: 'Elysia', link: '/docs/adapters/elysia' }, + { text: 'Express', link: '/docs/adapters/express' }, + { text: 'Fastify', link: '/docs/adapters/fastify' }, + { text: 'Hono', link: '/docs/adapters/hono' }, + { text: 'Next.js', link: '/docs/adapters/next' }, + { text: 'Nuxt', link: '/docs/adapters/nuxt' }, + { text: 'React Native', link: '/docs/adapters/react-native' }, + { text: 'Remix', link: '/docs/adapters/remix' }, + { text: 'Solid Start', link: '/docs/adapters/solid-start' }, + { text: 'Svelte Kit', link: '/docs/adapters/svelte-kit' }, + { text: 'Tanstack Start', link: '/docs/adapters/tanstack-start' }, + { text: 'Worker Threads', link: '/docs/adapters/worker-threads' }, ], }, - { - text: 'Integrations', - collapsed: true, - items: [ - { text: 'Astro', link: '/docs/integrations/astro' }, - { text: 'Browser', link: '/docs/integrations/browser' }, - { text: 'Electron', link: '/docs/integrations/electron' }, - { text: 'Elysia', link: '/docs/integrations/elysia' }, - { text: 'Express', link: '/docs/integrations/express' }, - { text: 'Fastify', link: '/docs/integrations/fastify' }, - { text: 'Hono', link: '/docs/integrations/hono' }, - { text: 'Next.js', link: '/docs/integrations/next' }, - { text: 'Nuxt', link: '/docs/integrations/nuxt' }, - { text: 'React Native', link: '/docs/integrations/react-native' }, - { text: 'Remix', link: '/docs/integrations/remix' }, - { text: 'Solid Start', link: '/docs/integrations/solid-start' }, - { text: 'SvelteKit', link: '/docs/integrations/svelte-kit' }, - { text: 'Tanstack Start', link: '/docs/integrations/tanstack-start' }, - { text: 'Worker Threads', link: '/docs/integrations/worker-threads' }, - ], - - }, { text: 'Plugins', collapsed: true, @@ -138,15 +132,24 @@ export default defineConfig({ ], }, { - text: 'Tanstack Query', + text: 'Integrations', collapsed: true, items: [ - { text: 'New', link: '/docs/tanstack-query/new' }, - { text: 'Basic', link: '/docs/tanstack-query/basic' }, - { text: 'React', link: '/docs/tanstack-query/react' }, - { text: 'Vue', link: '/docs/tanstack-query/vue' }, - { text: 'Solid', link: '/docs/tanstack-query/solid' }, - { text: 'Svelte', link: '/docs/tanstack-query/svelte' }, + { text: 'Tanstack Query', link: '/docs/integrations/tanstack-query' }, + { + text: 'Tanstack Query (Old)', + collapsed: true, + items: [ + { text: 'Basic', link: '/docs/integrations/tanstack-query-old/basic' }, + { text: 'React', link: '/docs/integrations/tanstack-query-old/react' }, + { text: 'Vue', link: '/docs/integrations/tanstack-query-old/vue' }, + { text: 'Solid', link: '/docs/integrations/tanstack-query-old/solid' }, + { text: 'Svelte', link: '/docs/integrations/tanstack-query-old/svelte' }, + ], + }, + { text: 'Pinia Colada', link: '/docs/integrations/pinia-colada' }, + { text: 'Hey API', link: '/docs/integrations/hey-api' }, + { text: 'NestJS', link: '/docs/openapi/integrations/implement-contract-in-nest' }, ], }, { @@ -174,9 +177,6 @@ export default defineConfig({ text: 'Others', collapsed: true, items: [ - { text: 'Pinia Colada', link: '/docs/pinia-colada' }, - { text: 'Hey API', link: '/docs/hey-api' }, - { text: 'NestJS', link: '/docs/openapi/nest/implement-contract' }, { text: 'Playgrounds', link: '/docs/playgrounds' }, { text: 'Comparison', link: '/docs/comparison' }, { text: 'Ecosystem', link: '/docs/ecosystem' }, @@ -208,10 +208,10 @@ export default defineConfig({ ], }, { - text: 'NestJS', + text: 'Integrations', collapsed: true, items: [ - { text: 'Implement Contract', link: '/docs/openapi/nest/implement-contract' }, + { text: 'Implement Contract in NestJS', link: '/docs/openapi/integrations/implement-contract-in-nest' }, ], }, { diff --git a/apps/content/docs/integrations/astro.md b/apps/content/docs/adapters/astro.md similarity index 88% rename from apps/content/docs/integrations/astro.md rename to apps/content/docs/adapters/astro.md index 52719b046..05a0a1364 100644 --- a/apps/content/docs/integrations/astro.md +++ b/apps/content/docs/adapters/astro.md @@ -1,14 +1,16 @@ --- -title: Astro Integration -description: Integrate oRPC with Astro +title: Astro Adapter +description: Use oRPC inside an Astro project --- -# Astro Integration +# Astro Adapter [Astro](https://astro.build/) is a JavaScript web framework optimized for building fast, content-driven websites. For additional context, refer to the [HTTP Adapter](/docs/adapters/http) guide. ## Basic +::: code-group + ```ts [pages/rpc/[...rest].ts] import { RPCHandler } from '@orpc/server/fetch' @@ -26,6 +28,8 @@ export const ALL: APIRoute = async ({ request }) => { } ``` +::: + ::: info The `handler` can be any supported oRPC handler, such as [RPCHandler](/docs/rpc-handler), [OpenAPIHandler](/docs/openapi/openapi-handler), or another custom handler. ::: diff --git a/apps/content/docs/integrations/browser.md b/apps/content/docs/adapters/browser.md similarity index 98% rename from apps/content/docs/integrations/browser.md rename to apps/content/docs/adapters/browser.md index 0b7895429..9fbf43796 100644 --- a/apps/content/docs/integrations/browser.md +++ b/apps/content/docs/adapters/browser.md @@ -1,9 +1,9 @@ --- -title: Browser Integration +title: Browser Adapter description: Type-safe communication between browser scripts using Message Port Adapter --- -# Browser Integration +# Browser Adapter Enable type-safe communication between browser scripts using the [Message Port Adapter](/docs/adapters/message-port). diff --git a/apps/content/docs/integrations/electron.md b/apps/content/docs/adapters/electron.md similarity index 94% rename from apps/content/docs/integrations/electron.md rename to apps/content/docs/adapters/electron.md index 48fa77bfb..c03842627 100644 --- a/apps/content/docs/integrations/electron.md +++ b/apps/content/docs/adapters/electron.md @@ -1,9 +1,9 @@ --- -title: Electron Integration -description: Integrate oRPC with Electron +title: Electron Adapter +description: Use oRPC inside an Electron project --- -# Electron Integration +# Electron Adapter Establish type-safe communication between processes in [Electron](https://www.electronjs.org/) using the [Message Port Adapter](/docs/adapters/message-port). Before you start, we recommend reading the [MessagePorts in Electron](https://www.electronjs.org/docs/latest/tutorial/message-ports) guide. diff --git a/apps/content/docs/integrations/elysia.md b/apps/content/docs/adapters/elysia.md similarity index 91% rename from apps/content/docs/integrations/elysia.md rename to apps/content/docs/adapters/elysia.md index d8ac88493..3aa2905fa 100644 --- a/apps/content/docs/integrations/elysia.md +++ b/apps/content/docs/adapters/elysia.md @@ -1,9 +1,9 @@ --- -title: Elysia Integration -description: Integrate oRPC with Elysia +title: Elysia Adapter +description: Use oRPC inside an Elysia project --- -# Elysia Integration +# Elysia Adapter [Elysia](https://elysiajs.com/) is a high-performance web framework for [Bun](https://bun.sh/) that adheres to the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). For additional context, refer to the [HTTP Adapter](/docs/adapters/http) guide. diff --git a/apps/content/docs/integrations/express.md b/apps/content/docs/adapters/express.md similarity index 90% rename from apps/content/docs/integrations/express.md rename to apps/content/docs/adapters/express.md index d3fbb3d1b..89a5090a1 100644 --- a/apps/content/docs/integrations/express.md +++ b/apps/content/docs/adapters/express.md @@ -1,9 +1,9 @@ --- -title: Express.js Integration -description: Seamlessly integrate oRPC with Express.js +title: Express.js Adapter +description: Use oRPC inside an Express.js project --- -# Express.js Integration +# Express.js Adapter [Express.js](https://expressjs.com/) is a popular Node.js framework for building web applications. For additional context, refer to the [HTTP Adapter](/docs/adapters/http) guide. diff --git a/apps/content/docs/integrations/fastify.md b/apps/content/docs/adapters/fastify.md similarity index 93% rename from apps/content/docs/integrations/fastify.md rename to apps/content/docs/adapters/fastify.md index 63396e1dc..bc0cccc61 100644 --- a/apps/content/docs/integrations/fastify.md +++ b/apps/content/docs/adapters/fastify.md @@ -1,9 +1,9 @@ --- -title: Fastify Integration -description: Seamlessly integrate oRPC with Fastify +title: Fastify Adapter +description: Use oRPC inside an Fastify project --- -# Fastify Integration +# Fastify Adapter [Fastify](https://fastify.dev/) is a web framework highly focused on providing the best developer experience with the least overhead and a powerful plugin architecture. For additional context, refer to the [HTTP Adapter](/docs/adapters/http) guide. diff --git a/apps/content/docs/integrations/hono.md b/apps/content/docs/adapters/hono.md similarity index 91% rename from apps/content/docs/integrations/hono.md rename to apps/content/docs/adapters/hono.md index 536ae1191..f166934af 100644 --- a/apps/content/docs/integrations/hono.md +++ b/apps/content/docs/adapters/hono.md @@ -1,9 +1,9 @@ --- -title: Hono Integration -description: Integrate oRPC with Hono +title: Hono Adapter +description: Use oRPC inside an Hono project --- -# Hono Integration +# Hono Adapter [Hono](https://honojs.dev/) is a high-performance web framework built on top of [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). For additional context, refer to the [HTTP Adapter](/docs/adapters/http) guide. diff --git a/apps/content/docs/adapters/message-port.md b/apps/content/docs/adapters/message-port.md index 58bf0aee7..565325eeb 100644 --- a/apps/content/docs/adapters/message-port.md +++ b/apps/content/docs/adapters/message-port.md @@ -7,11 +7,11 @@ description: Using oRPC with Message Ports oRPC offers built-in support for common Message Port implementations, enabling easy internal communication between different processes. -| Environment | Documentation | -| ------------------------------------------------------------------------------------------ | ------------------------------------------------------ | -| [Electron Message Port](https://www.electronjs.org/docs/latest/tutorial/message-ports) | [Integration Guide](/docs/integrations/electron) | -| Browser (extension background to popup/content, window to window, etc.) | [Integration Guide](/docs/integrations/browser) | -| [Node.js Worker Threads Port](https://nodejs.org/api/worker_threads.html#workerparentport) | [Integration Guide](/docs/integrations/worker-threads) | +| Environment | Documentation | +| ------------------------------------------------------------------------------------------ | ---------------------------------------------- | +| [Electron Message Port](https://www.electronjs.org/docs/latest/tutorial/message-ports) | [Adapter Guide](/docs/adapters/electron) | +| Browser (extension background to popup/content, window to window, etc.) | [Adapter Guide](/docs/adapters/browser) | +| [Node.js Worker Threads Port](https://nodejs.org/api/worker_threads.html#workerparentport) | [Adapter Guide](/docs/adapters/worker-threads) | ## Basic Usage diff --git a/apps/content/docs/integrations/next.md b/apps/content/docs/adapters/next.md similarity index 97% rename from apps/content/docs/integrations/next.md rename to apps/content/docs/adapters/next.md index f2e642a74..6bae3c6f2 100644 --- a/apps/content/docs/integrations/next.md +++ b/apps/content/docs/adapters/next.md @@ -1,9 +1,9 @@ --- -title: Next.js Integration -description: Seamlessly integrate oRPC with Next.js +title: Next.js Adapter +description: Use oRPC inside an Next.js project --- -# Next.js Integration +# Next.js Adapter [Next.js](https://nextjs.org/) is a leading React framework for server-rendered apps. oRPC works with both the [App Router](https://nextjs.org/docs/app/getting-started/installation) and [Pages Router](https://nextjs.org/docs/pages/getting-started/installation). For additional context, refer to the [HTTP Adapter](/docs/adapters/http) guide. diff --git a/apps/content/docs/integrations/nuxt.md b/apps/content/docs/adapters/nuxt.md similarity index 91% rename from apps/content/docs/integrations/nuxt.md rename to apps/content/docs/adapters/nuxt.md index 81e755a7c..261b266ca 100644 --- a/apps/content/docs/integrations/nuxt.md +++ b/apps/content/docs/adapters/nuxt.md @@ -1,9 +1,9 @@ --- -title: Nuxt.js Integration -description: Integrate oRPC with Nuxt.js +title: Nuxt.js Adapter +description: Use oRPC inside an Nuxt.js project --- -# Nuxt.js Integration +# Nuxt.js Adapter [Nuxt.js](https://nuxtjs.org/) is a popular Vue.js framework for building server-side applications. It built on top of [Nitro](https://nitro.build/) server a lightweight, high-performance Node.js runtime. For more details, see the [HTTP Adapter](/docs/adapters/http) guide. diff --git a/apps/content/docs/integrations/react-native.md b/apps/content/docs/adapters/react-native.md similarity index 91% rename from apps/content/docs/integrations/react-native.md rename to apps/content/docs/adapters/react-native.md index 7959a5e21..c09bec9fe 100644 --- a/apps/content/docs/integrations/react-native.md +++ b/apps/content/docs/adapters/react-native.md @@ -1,9 +1,9 @@ --- -title: React Native Integration -description: Seamlessly integrate oRPC with React Native +title: React Native Adapter +description: Use oRPC inside a React Native project --- -# React Native Integration +# React Native Adapter [React Native](https://reactnative.dev/) is a framework for building native apps using React. For additional context, refer to the [HTTP Adapter](/docs/adapters/http) guide. diff --git a/apps/content/docs/integrations/remix.md b/apps/content/docs/adapters/remix.md similarity index 90% rename from apps/content/docs/integrations/remix.md rename to apps/content/docs/adapters/remix.md index a1b3b728d..089d2c426 100644 --- a/apps/content/docs/integrations/remix.md +++ b/apps/content/docs/adapters/remix.md @@ -1,9 +1,9 @@ --- -title: Remix Integration -description: Integrate oRPC with Remix +title: Remix Adapter +description: Use oRPC inside an Remix project --- -# Remix Integration +# Remix Adapter [Remix](https://remix.run/) is a full stack JavaScript framework for building web applications with React. For additional context, refer to the [HTTP Adapter](/docs/adapters/http) guide. diff --git a/apps/content/docs/integrations/solid-start.md b/apps/content/docs/adapters/solid-start.md similarity index 90% rename from apps/content/docs/integrations/solid-start.md rename to apps/content/docs/adapters/solid-start.md index 5932930c8..a056e7e03 100644 --- a/apps/content/docs/integrations/solid-start.md +++ b/apps/content/docs/adapters/solid-start.md @@ -1,11 +1,11 @@ --- -title: Solid Start Integration -description: Setup oRPC within a Solid Start application +title: Solid Start Adapter +description: Use oRPC inside a Solid Start project --- -# SolidStart Integration +# Solid Start Adapter -[SolidStart](https://start.solidjs.com/) is a full stack JavaScript framework for building web applications with SolidJS. For additional context, refer to the [HTTP Adapter](/docs/adapters/http) guide. +[Solid Start](https://start.solidjs.com/) is a full stack JavaScript framework for building web applications with SolidJS. For additional context, refer to the [HTTP Adapter](/docs/adapters/http) guide. ## Server diff --git a/apps/content/docs/integrations/svelte-kit.md b/apps/content/docs/adapters/svelte-kit.md similarity index 71% rename from apps/content/docs/integrations/svelte-kit.md rename to apps/content/docs/adapters/svelte-kit.md index 62baa7a7e..fc5efc70d 100644 --- a/apps/content/docs/integrations/svelte-kit.md +++ b/apps/content/docs/adapters/svelte-kit.md @@ -1,11 +1,11 @@ --- -title: SvelteKit Integration -description: Integrate oRPC with SvelteKit +title: Svelte Kit Adapter +description: Use oRPC inside an Svelte Kit project --- -# SvelteKit Integration +# Svelte Kit Adapter -[SvelteKit](https://svelte.dev/docs/kit/introduction) is a framework for rapidly developing robust, performant web applications using Svelte. For additional context, refer to the [HTTP Adapter](/docs/adapters/http) guide. +[Svelte Kit](https://svelte.dev/docs/kit/introduction) is a framework for rapidly developing robust, performant web applications using Svelte. For additional context, refer to the [HTTP Adapter](/docs/adapters/http) guide. ## Basic diff --git a/apps/content/docs/integrations/tanstack-start.md b/apps/content/docs/adapters/tanstack-start.md similarity index 97% rename from apps/content/docs/integrations/tanstack-start.md rename to apps/content/docs/adapters/tanstack-start.md index 315ca7c1f..79228f3a7 100644 --- a/apps/content/docs/integrations/tanstack-start.md +++ b/apps/content/docs/adapters/tanstack-start.md @@ -1,9 +1,9 @@ --- -title: TanStack Start Integration -description: Integrate oRPC with TanStack Start +title: TanStack Start Adapter +description: Use oRPC inside a TanStack Start project --- -# TanStack Start Integration +# TanStack Start Adapter [TanStack Start](https://tanstack.com/start) is a full-stack React framework built on [Nitro](https://nitro.build/) and the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). For additional context, see the [HTTP Adapter](/docs/adapters/http) guide. diff --git a/apps/content/docs/integrations/worker-threads.md b/apps/content/docs/adapters/worker-threads.md similarity index 95% rename from apps/content/docs/integrations/worker-threads.md rename to apps/content/docs/adapters/worker-threads.md index 1e5930d74..8d7dd6c0d 100644 --- a/apps/content/docs/integrations/worker-threads.md +++ b/apps/content/docs/adapters/worker-threads.md @@ -1,9 +1,9 @@ --- -title: Worker Threads Integration +title: Worker Threads Adapter description: Enable type-safe communication between Node.js Worker Threads using oRPC. --- -# Worker Threads Integration +# Worker Threads Adapter Use [Node.js Worker Threads](https://nodejs.org/api/worker_threads.html) with oRPC for type-safe inter-thread communication via the [Message Port Adapter](/docs/adapters/message-port). Before proceeding, we recommend reviewing the [Node.js Worker Thread API](https://nodejs.org/api/worker_threads.html). diff --git a/apps/content/docs/best-practices/optimize-ssr.md b/apps/content/docs/best-practices/optimize-ssr.md index fc8aa23eb..a43cb8209 100644 --- a/apps/content/docs/best-practices/optimize-ssr.md +++ b/apps/content/docs/best-practices/optimize-ssr.md @@ -170,7 +170,7 @@ This example uses Next.js, but you can apply the same pattern in SvelteKit, Nuxt ## TanStack Query -Combining this oRPC setup with TanStack Query (React Query, Solid Query, etc.) provides a powerful pattern for data fetching, and state management, especially with Suspense hooks. Refer to these details in [Tanstack Query Integration Guide](/docs/tanstack-query/basic) and [Tanstack Query SSR Guide](https://tanstack.com/query/latest/docs/framework/react/guides/ssr). +Combining this oRPC setup with TanStack Query (React Query, Solid Query, etc.) provides a powerful pattern for data fetching, and state management, especially with Suspense hooks. Refer to these details in [Tanstack Query Integration Guide](/docs/integrations/tanstack-query-old/basic) and [Tanstack Query SSR Guide](https://tanstack.com/query/latest/docs/framework/react/guides/ssr). ```tsx export default function PlanetListPage() { diff --git a/apps/content/docs/comparison.md b/apps/content/docs/comparison.md index 18a127a3d..8240508fa 100644 --- a/apps/content/docs/comparison.md +++ b/apps/content/docs/comparison.md @@ -17,11 +17,12 @@ This comparison table helps you understand how oRPC differs from other popular T | End-to-end Typesafe Errors | [1](/docs/client/error-handling), [2](/docs/error-handling#type%E2%80%90safe-error-handling) | ✅ | 🟡 | ✅ | | End-to-end Typesafe File/Blob | [1](/docs/file-upload-download) | ✅ | 🟡 | 🛑 | | End-to-end Typesafe Streaming | [1](/docs/event-iterator) | ✅ | ✅ | 🛑 | -| Tanstack Query Integration (React) | [1](/docs/tanstack-query/react) | ✅ | ✅ | 🟡 | -| Tanstack Query Integration (Vue) | [1](/docs/tanstack-query/vue) | ✅ | 🛑 | 🟡 | -| Tanstack Query Integration (Solid) | [1](/docs/tanstack-query/solid) | ✅ | 🛑 | 🟡 | -| Tanstack Query Integration (Svelte) | [1](/docs/tanstack-query/svelte) | ✅ | 🛑 | 🛑 | -| Vue Pinia Colada Integration | [1](/docs/pinia-colada) | ✅ | 🛑 | 🛑 | +| Tanstack Query Integration (React) | [1](/docs/integrations/tanstack-query) | ✅ | ✅ | 🟡 | +| Tanstack Query Integration (Vue) | [1](/docs/integrations/tanstack-query) | ✅ | 🛑 | 🟡 | +| Tanstack Query Integration (Solid) | [1](/docs/integrations/tanstack-query) | ✅ | 🛑 | 🟡 | +| Tanstack Query Integration (Svelte) | [1](/docs/integrations/tanstack-query) | ✅ | 🛑 | 🛑 | +| Tanstack Query Integration (Angular) | [1](/docs/integrations/tanstack-query) | ✅ | 🛑 | 🛑 | +| Vue Pinia Colada Integration | [1](/docs/integrations/pinia-colada) | ✅ | 🛑 | 🛑 | | With Contract-First Approach | [1](/docs/contract-first/define-contract) | ✅ | 🛑 | ✅ | | Without Contract-First Approach | | ✅ | ✅ | 🛑 | | OpenAPI Support | [1](/docs/openapi/openapi-handler) | ✅ | 🟡 | 🟡 | @@ -35,5 +36,5 @@ This comparison table helps you understand how oRPC differs from other popular T | Built-in Plugins (CORS, CSRF, Retry, ...) | | ✅ | 🛑 | 🛑 | | Batch Request/Response | [1](/docs/plugins/batch-request-response) | ✅ | ✅ | 🛑 | | WebSockets | [1](/docs/adapters/websocket) | ✅ | ✅ | 🛑 | -| Nest.js integration | [1](/docs/openapi/nest/implement-contract) | ✅ | 🟡 | ✅ | +| Nest.js integration | [1](/docs/openapi/integrations/implement-contract-in-nest) | ✅ | 🟡 | ✅ | | Message Port (Electron, Browser, Workers, ...) | [1](/docs/adapters/message-port) | ✅ | 🟡 | 🛑 | diff --git a/apps/content/docs/hey-api.md b/apps/content/docs/integrations/hey-api.md similarity index 100% rename from apps/content/docs/hey-api.md rename to apps/content/docs/integrations/hey-api.md diff --git a/apps/content/docs/pinia-colada.md b/apps/content/docs/integrations/pinia-colada.md similarity index 100% rename from apps/content/docs/pinia-colada.md rename to apps/content/docs/integrations/pinia-colada.md diff --git a/apps/content/docs/tanstack-query/basic.md b/apps/content/docs/integrations/tanstack-query-old/basic.md similarity index 100% rename from apps/content/docs/tanstack-query/basic.md rename to apps/content/docs/integrations/tanstack-query-old/basic.md diff --git a/apps/content/docs/tanstack-query/react.md b/apps/content/docs/integrations/tanstack-query-old/react.md similarity index 98% rename from apps/content/docs/tanstack-query/react.md rename to apps/content/docs/integrations/tanstack-query-old/react.md index 533b27fe6..9c358efd0 100644 --- a/apps/content/docs/tanstack-query/react.md +++ b/apps/content/docs/integrations/tanstack-query-old/react.md @@ -5,7 +5,7 @@ description: Seamlessly integrate oRPC with Tanstack Query for React # Tanstack Query Integration For React -This guide shows how to integrate oRPC with Tanstack Query for React. For an introduction, please review the [Basic Guide](/docs/tanstack-query/basic) first. +This guide shows how to integrate oRPC with Tanstack Query for React. For an introduction, please review the [Basic Guide](/docs/integrations/tanstack-query-old/basic) first. ## Installation diff --git a/apps/content/docs/tanstack-query/solid.md b/apps/content/docs/integrations/tanstack-query-old/solid.md similarity index 97% rename from apps/content/docs/tanstack-query/solid.md rename to apps/content/docs/integrations/tanstack-query-old/solid.md index 443d90422..9680160ff 100644 --- a/apps/content/docs/tanstack-query/solid.md +++ b/apps/content/docs/integrations/tanstack-query-old/solid.md @@ -5,7 +5,7 @@ description: Seamlessly integrate oRPC with Tanstack Query for Solid # Tanstack Query Integration For Solid -This guide shows how to integrate oRPC with Tanstack Query for Solid. For an introduction, please review the [Basic Guide](/docs/tanstack-query/basic) first. +This guide shows how to integrate oRPC with Tanstack Query for Solid. For an introduction, please review the [Basic Guide](/docs/integrations/tanstack-query-old/basic) first. ## Installation diff --git a/apps/content/docs/tanstack-query/svelte.md b/apps/content/docs/integrations/tanstack-query-old/svelte.md similarity index 97% rename from apps/content/docs/tanstack-query/svelte.md rename to apps/content/docs/integrations/tanstack-query-old/svelte.md index f460b1e78..d7ff4f996 100644 --- a/apps/content/docs/tanstack-query/svelte.md +++ b/apps/content/docs/integrations/tanstack-query-old/svelte.md @@ -5,7 +5,7 @@ description: Seamlessly integrate oRPC with Tanstack Query for Svelte # Tanstack Query Integration For Svelte -This guide shows how to integrate oRPC with Tanstack Query for Svelte. For an introduction, please review the [Basic Guide](/docs/tanstack-query/basic) first. +This guide shows how to integrate oRPC with Tanstack Query for Svelte. For an introduction, please review the [Basic Guide](/docs/integrations/tanstack-query-old/basic) first. ## Installation diff --git a/apps/content/docs/tanstack-query/vue.md b/apps/content/docs/integrations/tanstack-query-old/vue.md similarity index 93% rename from apps/content/docs/tanstack-query/vue.md rename to apps/content/docs/integrations/tanstack-query-old/vue.md index f80ac1778..1c8046cbf 100644 --- a/apps/content/docs/tanstack-query/vue.md +++ b/apps/content/docs/integrations/tanstack-query-old/vue.md @@ -5,7 +5,7 @@ description: Seamlessly integrate oRPC with Tanstack Query for Vue # Tanstack Query Integration For Vue -This guide shows how to integrate oRPC with Tanstack Query for Vue. For an introduction, please review the [Basic Guide](/docs/tanstack-query/basic) first. +This guide shows how to integrate oRPC with Tanstack Query for Vue. For an introduction, please review the [Basic Guide](/docs/integrations/tanstack-query-old/basic) first. ## Installation diff --git a/apps/content/docs/tanstack-query/new.md b/apps/content/docs/integrations/tanstack-query.md similarity index 98% rename from apps/content/docs/tanstack-query/new.md rename to apps/content/docs/integrations/tanstack-query.md index 36720675b..256c08805 100644 --- a/apps/content/docs/tanstack-query/new.md +++ b/apps/content/docs/integrations/tanstack-query.md @@ -1,9 +1,9 @@ --- -title: Tanstack Query Integration (New) +title: Tanstack Query Integration description: Seamlessly integrate oRPC with Tanstack Query --- -# Tanstack Query Integration (New) +# Tanstack Query Integration [Tanstack Query](https://tanstack.com/query/latest) is a robust solution for asynchronous state management. oRPC Tanstack Query integration is very lightweight and straightforward - supporting all libraries that Tanstack Query supports (React, Vue, Angular, Solid, Svelte, etc.). diff --git a/apps/content/docs/openapi/nest/implement-contract.md b/apps/content/docs/openapi/integrations/implement-contract-in-nest.md similarity index 99% rename from apps/content/docs/openapi/nest/implement-contract.md rename to apps/content/docs/openapi/integrations/implement-contract-in-nest.md index 3f29d8862..15fc469c2 100644 --- a/apps/content/docs/openapi/nest/implement-contract.md +++ b/apps/content/docs/openapi/integrations/implement-contract-in-nest.md @@ -1,6 +1,6 @@ --- title: Implement Contract in NestJS -description: Seamlessly implement oRPC contracts in your NestJS applications. +description: Seamlessly implement oRPC contracts in your NestJS projects. --- # Implement Contract in NestJS diff --git a/packages/hey-api/src/to-orpc-client.ts b/packages/hey-api/src/to-orpc-client.ts index 09b7a0c7b..9a8278092 100644 --- a/packages/hey-api/src/to-orpc-client.ts +++ b/packages/hey-api/src/to-orpc-client.ts @@ -7,6 +7,11 @@ export type experimental_ToORPCClientResult> = { : never } +/** + * Convert a Hey API SDK to an oRPC client. + * + * @see {@link https://orpc.unnoq.com/docs/integrations/hey-api Hey API Docs} + */ export function experimental_toORPCClient>(sdk: T): experimental_ToORPCClientResult { const client = {} as Record, undefined | Record, any, any>> diff --git a/packages/nest/README.md b/packages/nest/README.md index d7cf0b7a1..caa304711 100644 --- a/packages/nest/README.md +++ b/packages/nest/README.md @@ -63,7 +63,7 @@ You can find the full documentation [here](https://orpc.unnoq.com). ## `@orpc/nest` -Deeply integrate oRPC with [NestJS](https://nestjs.com/). Read the [documentation](https://orpc.unnoq.com/docs/openapi/nest/implement-contract) for more information. +Deeply integrate oRPC with [NestJS](https://nestjs.com/). Read the [documentation](https://orpc.unnoq.com/docs/openapi/integrations/implement-contract-in-nest) for more information. ### Implement Contract diff --git a/packages/nest/src/implement.ts b/packages/nest/src/implement.ts index 3579fbb0f..ec06fffde 100644 --- a/packages/nest/src/implement.ts +++ b/packages/nest/src/implement.ts @@ -32,7 +32,7 @@ const MethodDecoratorMap = { /** * Decorator in controller handler to implement a oRPC contract. * - * @see {@link https://orpc.unnoq.com/docs/openapi/nest/implement-contract#implement-your-contract NestJS Implement Contract Docs} + * @see {@link https://orpc.unnoq.com/docs/openapi/integrations/implement-contract-in-nest#implement-your-contract NestJS Implement Contract Docs} */ export function Implement>( contract: T, diff --git a/packages/nest/src/utils.ts b/packages/nest/src/utils.ts index c3ee0c9f6..0da77271b 100644 --- a/packages/nest/src/utils.ts +++ b/packages/nest/src/utils.ts @@ -27,7 +27,7 @@ export interface PopulateContractRouterPathsOptions { * This utility automatically populates any missing paths * Using the router's keys + `/`. * - * @see {@link https://orpc.unnoq.com/docs/openapi/nest/implement-contract#define-your-contract NestJS Implement Contract Docs} + * @see {@link https://orpc.unnoq.com/docs/openapi/integrations/implement-contract-in-nest#define-your-contract NestJS Implement Contract Docs} */ export function populateContractRouterPaths(router: T, options: PopulateContractRouterPathsOptions = {}): PopulatedContractRouterPaths { const path = toArray(options.path) diff --git a/packages/react-query/README.md b/packages/react-query/README.md index bf155bf63..a0ee49223 100644 --- a/packages/react-query/README.md +++ b/packages/react-query/README.md @@ -63,7 +63,7 @@ You can find the full documentation [here](https://orpc.unnoq.com). ## `@orpc/react-query` -Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview). Read the [documentation](https://orpc.unnoq.com/docs/tanstack-query/react) for more information. +Integration with [React Query](https://tanstack.com/query/latest/docs/framework/react/overview). Read the [documentation](https://orpc.unnoq.com/docs/integrations/tanstack-query-old/react) for more information. ```ts export function Example() { diff --git a/packages/react-query/src/general-utils.ts b/packages/react-query/src/general-utils.ts index 971504aa2..71a362350 100644 --- a/packages/react-query/src/general-utils.ts +++ b/packages/react-query/src/general-utils.ts @@ -9,7 +9,7 @@ export interface GeneralUtils { /** * Generate a query/mutation key for checking status, invalidate, set, get, etc. * - * @see {@link https://orpc.unnoq.com/docs/tanstack-query/basic#query-mutation-key Tanstack Query/Mutation Key Docs} + * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query-old/basic#query-mutation-key Tanstack Query/Mutation Key Docs} */ key(options?: OperationKeyOptions): QueryKey } diff --git a/packages/react-query/src/procedure-utils.ts b/packages/react-query/src/procedure-utils.ts index bad0080be..474e9645a 100644 --- a/packages/react-query/src/procedure-utils.ts +++ b/packages/react-query/src/procedure-utils.ts @@ -20,14 +20,14 @@ export interface ProcedureUtils /** * Generate options used for useQuery/useSuspenseQuery/prefetchQuery/... * - * @see {@link https://orpc.unnoq.com/docs/tanstack-query/basic#query-options-utility Tanstack Query Options Utility Docs} + * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query-old/basic#query-options-utility Tanstack Query Options Utility Docs} */ queryOptions( ...rest: MaybeOptionalOptions< @@ -39,7 +39,7 @@ export interface ProcedureUtils>( ...rest: MaybeOptionalOptions< @@ -50,7 +50,7 @@ export interface ProcedureUtils>( options: U & InfiniteOptionsIn @@ -59,7 +59,7 @@ export interface ProcedureUtils( ...rest: MaybeOptionalOptions> diff --git a/packages/react-query/src/router-utils.ts b/packages/react-query/src/router-utils.ts index cfc501542..81da7c6f7 100644 --- a/packages/react-query/src/router-utils.ts +++ b/packages/react-query/src/router-utils.ts @@ -19,7 +19,7 @@ export interface CreateRouterUtilsOptions { * Create a router utils from a client. * * @info Both client-side and server-side clients are supported. - * @see {@link https://orpc.unnoq.com/docs/tanstack-query/react Tanstack Query React Docs} + * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query-old/react Tanstack Query React Docs} */ export function createRouterUtils>( client: T, diff --git a/packages/solid-query/README.md b/packages/solid-query/README.md index 7a6cf135b..1123bfcc9 100644 --- a/packages/solid-query/README.md +++ b/packages/solid-query/README.md @@ -63,7 +63,7 @@ You can find the full documentation [here](https://orpc.unnoq.com). ## `@orpc/solid-query` -Integration with [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview). Read the [documentation](https://orpc.unnoq.com/docs/tanstack-query/solid) for more information. +Integration with [Solid Query](https://tanstack.com/query/latest/docs/framework/solid/overview). Read the [documentation](https://orpc.unnoq.com/docs/integrations/tanstack-query-old/solid) for more information. ```ts export function Example() { diff --git a/packages/solid-query/src/general-utils.ts b/packages/solid-query/src/general-utils.ts index a7836dbdd..c341e001b 100644 --- a/packages/solid-query/src/general-utils.ts +++ b/packages/solid-query/src/general-utils.ts @@ -9,7 +9,7 @@ export interface GeneralUtils { /** * Generate a query/mutation key for checking status, invalidate, set, get, etc. * - * @see {@link https://orpc.unnoq.com/docs/tanstack-query/basic#query-mutation-key Tanstack Query/Mutation Key Docs} + * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query-old/basic#query-mutation-key Tanstack Query/Mutation Key Docs} */ key(options?: OperationKeyOptions): QueryKey } diff --git a/packages/solid-query/src/procedure-utils.ts b/packages/solid-query/src/procedure-utils.ts index 9a89a93fd..964f9366d 100644 --- a/packages/solid-query/src/procedure-utils.ts +++ b/packages/solid-query/src/procedure-utils.ts @@ -10,14 +10,14 @@ export interface ProcedureUtils /** * Generate options used for createQuery/prefetchQuery/... * - * @see {@link https://orpc.unnoq.com/docs/tanstack-query/basic#query-options-utility Tanstack Query Options Utility Docs} + * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query-old/basic#query-options-utility Tanstack Query Options Utility Docs} */ queryOptions( ...rest: MaybeOptionalOptions< @@ -29,7 +29,7 @@ export interface ProcedureUtils>( ...rest: MaybeOptionalOptions< @@ -40,7 +40,7 @@ export interface ProcedureUtils>( options: U & InfiniteOptionsIn @@ -49,7 +49,7 @@ export interface ProcedureUtils( ...rest: MaybeOptionalOptions> diff --git a/packages/solid-query/src/router-utils.ts b/packages/solid-query/src/router-utils.ts index 95abc090a..ad4c4aa1d 100644 --- a/packages/solid-query/src/router-utils.ts +++ b/packages/solid-query/src/router-utils.ts @@ -19,7 +19,7 @@ export interface CreateRouterUtilsOptions { * Create a router utils from a client. * * @info Both client-side and server-side clients are supported. - * @see {@link https://orpc.unnoq.com/docs/tanstack-query/solid Tanstack Query Solid Docs} + * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query-old/solid Tanstack Query Solid Docs} */ export function createRouterUtils>( client: T, diff --git a/packages/svelte-query/README.md b/packages/svelte-query/README.md index ccb2de18f..58f299bb2 100644 --- a/packages/svelte-query/README.md +++ b/packages/svelte-query/README.md @@ -63,7 +63,7 @@ You can find the full documentation [here](https://orpc.unnoq.com). ## `@orpc/svelte-query` -Integration with [Svelte Query](https://tanstack.com/query/latest/docs/framework/svelte/overview). Read the [documentation](https://orpc.unnoq.com/docs/tanstack-query/svelte) for more information. +Integration with [Svelte Query](https://tanstack.com/query/latest/docs/framework/svelte/overview). Read the [documentation](https://orpc.unnoq.com/docs/integrations/tanstack-query-old/svelte) for more information. ```ts export function Example() { diff --git a/packages/svelte-query/src/general-utils.ts b/packages/svelte-query/src/general-utils.ts index 8ab20f65c..e12fb97af 100644 --- a/packages/svelte-query/src/general-utils.ts +++ b/packages/svelte-query/src/general-utils.ts @@ -9,7 +9,7 @@ export interface GeneralUtils { /** * Generate a query/mutation key for checking status, invalidate, set, get, etc. * - * @see {@link https://orpc.unnoq.com/docs/tanstack-query/basic#query-mutation-key Tanstack Query/Mutation Key Docs} + * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query-old/basic#query-mutation-key Tanstack Query/Mutation Key Docs} */ key(options?: OperationKeyOptions): QueryKey } diff --git a/packages/svelte-query/src/procedure-utils.ts b/packages/svelte-query/src/procedure-utils.ts index 56fdb137d..dc0b093c1 100644 --- a/packages/svelte-query/src/procedure-utils.ts +++ b/packages/svelte-query/src/procedure-utils.ts @@ -10,14 +10,14 @@ export interface ProcedureUtils /** * Generate options used for createQuery/prefetchQuery/... * - * @see {@link https://orpc.unnoq.com/docs/tanstack-query/basic#query-options-utility Tanstack Query Options Utility Docs} + * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query-old/basic#query-options-utility Tanstack Query Options Utility Docs} */ queryOptions( ...rest: MaybeOptionalOptions< @@ -29,7 +29,7 @@ export interface ProcedureUtils>( ...rest: MaybeOptionalOptions< @@ -40,7 +40,7 @@ export interface ProcedureUtils>( options: U & InfiniteOptionsIn @@ -49,7 +49,7 @@ export interface ProcedureUtils( ...rest: MaybeOptionalOptions> diff --git a/packages/svelte-query/src/router-utils.ts b/packages/svelte-query/src/router-utils.ts index 466146f3d..7010c3d3f 100644 --- a/packages/svelte-query/src/router-utils.ts +++ b/packages/svelte-query/src/router-utils.ts @@ -19,7 +19,7 @@ export interface CreateRouterUtilsOptions { * Create a router utils from a client. * * @info Both client-side and server-side clients are supported. - * @see {@link https://orpc.unnoq.com/docs/tanstack-query/svelte Tanstack Query Svelte Docs} + * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query-old/svelte Tanstack Query Svelte Docs} */ export function createRouterUtils>( client: T, diff --git a/packages/tanstack-query/src/general-utils.ts b/packages/tanstack-query/src/general-utils.ts index 9cf37f76a..155e63565 100644 --- a/packages/tanstack-query/src/general-utils.ts +++ b/packages/tanstack-query/src/general-utils.ts @@ -8,7 +8,7 @@ export interface GeneralUtils { /** * Generate a query/mutation key for checking status, invalidate, set, get, etc. * - * @see {@link https://orpc.unnoq.com/docs/tanstack-query/basic#query-mutation-key Tanstack Query/Mutation Key Docs} + * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query-old/basic#query-mutation-key Tanstack Query/Mutation Key Docs} */ key(options?: OperationKeyOptions): OperationKey } diff --git a/packages/tanstack-query/src/procedure-utils.ts b/packages/tanstack-query/src/procedure-utils.ts index 7ec2675bf..2f573b922 100644 --- a/packages/tanstack-query/src/procedure-utils.ts +++ b/packages/tanstack-query/src/procedure-utils.ts @@ -24,14 +24,14 @@ export interface ProcedureUtils /** * Generate options used for useQuery/useSuspenseQuery/prefetchQuery/... * - * @see {@link https://orpc.unnoq.com/docs/tanstack-query/basic#query-options-utility Tanstack Query Options Utility Docs} + * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query-old/basic#query-options-utility Tanstack Query Options Utility Docs} */ queryOptions( ...rest: MaybeOptionalOptions< @@ -43,7 +43,7 @@ export interface ProcedureUtils>( ...rest: MaybeOptionalOptions< @@ -54,7 +54,7 @@ export interface ProcedureUtils>( options: U & InfiniteOptionsIn @@ -63,7 +63,7 @@ export interface ProcedureUtils( ...rest: MaybeOptionalOptions< diff --git a/packages/vue-colada/README.md b/packages/vue-colada/README.md index 6f2ddcdf1..9f5d36228 100644 --- a/packages/vue-colada/README.md +++ b/packages/vue-colada/README.md @@ -63,7 +63,7 @@ You can find the full documentation [here](https://orpc.unnoq.com). ## `@orpc/vue-colada` -Integration with [Pinia Colada](https://pinia-colada.esm.dev/). Read the [documentation](https://orpc.unnoq.com/docs/pinia-colada) for more information. +Integration with [Pinia Colada](https://pinia-colada.esm.dev/). Read the [documentation](https://orpc.unnoq.com/docs/integrations/pinia-colada) for more information. ```ts export function Setup() { diff --git a/packages/vue-colada/src/general-utils.ts b/packages/vue-colada/src/general-utils.ts index 96776c13e..8a8f5201b 100644 --- a/packages/vue-colada/src/general-utils.ts +++ b/packages/vue-colada/src/general-utils.ts @@ -6,7 +6,7 @@ export interface GeneralUtils { /** * Generate a query/mutation key for checking status, invalidate, set, get, etc. * - * @see {@link https://orpc.unnoq.com/docs/pinia-colada#query-mutation-key Pinia Colada Query/Mutation Key Docs} + * @see {@link https://orpc.unnoq.com/docs/integrations/pinia-colada#query-mutation-key Pinia Colada Query/Mutation Key Docs} */ key(options?: BuildKeyOptions): EntryKey } diff --git a/packages/vue-colada/src/procedure-utils.ts b/packages/vue-colada/src/procedure-utils.ts index 17feb58f1..fced88fa4 100644 --- a/packages/vue-colada/src/procedure-utils.ts +++ b/packages/vue-colada/src/procedure-utils.ts @@ -9,14 +9,14 @@ export interface ProcedureUtils /** * Generate options used for useQuery/... * - * @see {@link https://orpc.unnoq.com/docs/pinia-colada#query-options-utility Pinia Colada Query Options Utility Docs} + * @see {@link https://orpc.unnoq.com/docs/integrations/pinia-colada#query-options-utility Pinia Colada Query Options Utility Docs} */ queryOptions( ...rest: MaybeOptionalOptions< @@ -27,7 +27,7 @@ export interface ProcedureUtils = _EmptyObject>( ...rest: MaybeOptionalOptions< diff --git a/packages/vue-colada/src/router-utils.ts b/packages/vue-colada/src/router-utils.ts index ab5823c51..ff189f1b8 100644 --- a/packages/vue-colada/src/router-utils.ts +++ b/packages/vue-colada/src/router-utils.ts @@ -19,7 +19,7 @@ export interface CreateRouterUtilsOptions { * Create a router utils from a client. * * @info Both client-side and server-side clients are supported. - * @see {@link https://orpc.unnoq.com/docs/pinia-colada Pinia Colada Docs} + * @see {@link https://orpc.unnoq.com/docs/integrations/pinia-colada Pinia Colada Docs} */ export function createRouterUtils>( client: T, diff --git a/packages/vue-query/README.md b/packages/vue-query/README.md index abb9cbeae..6670376d3 100644 --- a/packages/vue-query/README.md +++ b/packages/vue-query/README.md @@ -63,7 +63,7 @@ You can find the full documentation [here](https://orpc.unnoq.com). ## `@orpc/vue-query` -Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview). Read the [documentation](https://orpc.unnoq.com/docs/tanstack-query/vue) for more information. +Integration with [Vue Query](https://tanstack.com/query/latest/docs/framework/vue/overview). Read the [documentation](https://orpc.unnoq.com/docs/integrations/tanstack-query-old/vue) for more information. ```ts export function Setup() { diff --git a/packages/vue-query/src/general-utils.ts b/packages/vue-query/src/general-utils.ts index a8128d6c3..88958390c 100644 --- a/packages/vue-query/src/general-utils.ts +++ b/packages/vue-query/src/general-utils.ts @@ -6,7 +6,7 @@ export interface GeneralUtils { /** * Generate a query/mutation key for checking status, invalidate, set, get, etc. * - * @see {@link https://orpc.unnoq.com/docs/tanstack-query/basic#query-mutation-key Tanstack Query/Mutation Key Docs} + * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query-old/basic#query-mutation-key Tanstack Query/Mutation Key Docs} */ key(options?: OperationKeyOptions): QueryKey } diff --git a/packages/vue-query/src/procedure-utils.ts b/packages/vue-query/src/procedure-utils.ts index 4cb67c4a3..f44639af7 100644 --- a/packages/vue-query/src/procedure-utils.ts +++ b/packages/vue-query/src/procedure-utils.ts @@ -12,14 +12,14 @@ export interface ProcedureUtils /** * Generate options used for useQuery/prefetchQuery/... * - * @see {@link https://orpc.unnoq.com/docs/tanstack-query/basic#query-options-utility Tanstack Query Options Utility Docs} + * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query-old/basic#query-options-utility Tanstack Query Options Utility Docs} */ queryOptions( ...rest: MaybeOptionalOptions< @@ -31,7 +31,7 @@ export interface ProcedureUtils>( ...rest: MaybeOptionalOptions< @@ -42,7 +42,7 @@ export interface ProcedureUtils>( options: U & InfiniteOptionsIn @@ -51,7 +51,7 @@ export interface ProcedureUtils( ...rest: MaybeOptionalOptions> diff --git a/packages/vue-query/src/router-utils.ts b/packages/vue-query/src/router-utils.ts index 100d74dd6..93d7daaf1 100644 --- a/packages/vue-query/src/router-utils.ts +++ b/packages/vue-query/src/router-utils.ts @@ -19,7 +19,7 @@ export interface CreateRouterUtilsOptions { * Create a router utils from a client. * * @info Both client-side and server-side clients are supported. - * @see {@link https://orpc.unnoq.com/docs/tanstack-query/vue Tanstack Query Vue Docs} + * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-query-old/vue Tanstack Query Vue Docs} */ export function createRouterUtils>( client: T, diff --git a/playgrounds/next/src/lib/orpc.server.ts b/playgrounds/next/src/lib/orpc.server.ts index aea732baa..7c9050a9a 100644 --- a/playgrounds/next/src/lib/orpc.server.ts +++ b/playgrounds/next/src/lib/orpc.server.ts @@ -7,7 +7,7 @@ import { headers } from 'next/headers' /** * This is part of the Optimize SSR setup. * - * @see {@link https://orpc.unnoq.com/docs/integrations/next#optimize-ssr} + * @see {@link https://orpc.unnoq.com/docs/adapters/next#optimize-ssr} */ globalThis.$client = createRouterClient(router, { /** diff --git a/playgrounds/next/src/lib/orpc.ts b/playgrounds/next/src/lib/orpc.ts index 038786ca2..bd65eaba9 100644 --- a/playgrounds/next/src/lib/orpc.ts +++ b/playgrounds/next/src/lib/orpc.ts @@ -8,7 +8,7 @@ import { BatchLinkPlugin } from '@orpc/client/plugins' /** * This is part of the Optimize SSR setup. * - * @see {@link https://orpc.unnoq.com/docs/integrations/next#optimize-ssr} + * @see {@link https://orpc.unnoq.com/docs/adapters/next#optimize-ssr} */ declare global { var $client: RouterClient | undefined diff --git a/playgrounds/solid-start/src/lib/orpc.server.ts b/playgrounds/solid-start/src/lib/orpc.server.ts index 14e8350cb..71cc88264 100644 --- a/playgrounds/solid-start/src/lib/orpc.server.ts +++ b/playgrounds/solid-start/src/lib/orpc.server.ts @@ -9,7 +9,7 @@ if (typeof window !== 'undefined') { /** * This is part of the Optimize SSR setup. * - * @see {@link https://orpc.unnoq.com/docs/integrations/solid-start#optimize-ssr} + * @see {@link https://orpc.unnoq.com/docs/adapters/solid-start#optimize-ssr} */ globalThis.$client = createRouterClient(router, { /** diff --git a/playgrounds/tanstack-start/src/lib/orpc.ts b/playgrounds/tanstack-start/src/lib/orpc.ts index c7b820713..8f8d41122 100644 --- a/playgrounds/tanstack-start/src/lib/orpc.ts +++ b/playgrounds/tanstack-start/src/lib/orpc.ts @@ -11,7 +11,7 @@ import { createIsomorphicFn } from '@tanstack/react-start' /** * This is part of the Optimize SSR setup. * - * @see {@link https://orpc.unnoq.com/docs/integrations/tanstack-start#optimize-ssr} + * @see {@link https://orpc.unnoq.com/docs/adapters/tanstack-start#optimize-ssr} */ const getORPCClient = createIsomorphicFn() .server(() => createRouterClient(router, {