@nuxt/docs-nightly 4.6.0-29802927.f10d9c49 → 4.6.0-29803063.d6c7d394

package/4.api/5.kit/12.nitro.md

@@ -8,7 +8,7 @@ links:
     size: xs
 ---
 
-Nitro is an open source TypeScript framework to build ultra-fast web servers. Nuxt uses Nitro as its server engine. You can use `useNitro` to access the Nitro instance, `addServerHandler` to add a server handler, `addDevServerHandler` to add a server handler to be used only in development mode, `addServerPlugin` to add a plugin to extend Nitro's runtime behavior, and `addPrerenderRoutes` to add routes to be prerendered by Nitro.
+Nitro is an open source TypeScript framework to build ultra-fast web servers. Nuxt uses Nitro as its server engine. You can use `useNitro` to access the Nitro instance (or `tryUseNitro` if your module should also work without Nitro), `addServerHandler` to add a server handler, `addDevServerHandler` to add a server handler to be used only in development mode, `addServerPlugin` to add a plugin to extend Nitro's runtime behavior, and `addPrerenderRoutes` to add routes to be prerendered by Nitro.
 
 ## `addServerHandler`
 
@@ -189,6 +189,40 @@ export default defineNuxtModule({
 function useNitro (): Nitro
 ```
 
+## `tryUseNitro`
+
+Returns the Nitro instance, or `undefined` when there is none.
+
+There is no Nitro instance before the `ready` hook has run, and none at all when the
+configured [`server.builder`](/docs/api/nuxt-config#builder-1) does not use Nitro, such as a
+builder that outputs a client-only SPA. Use this rather than `useNitro()` for anything that
+should keep working without a server: server routes, route rules and prerendering are all
+absent in that case.
+
+### Usage
+
+```ts
+import { defineNuxtModule, tryUseNitro } from '@nuxt/kit'
+
+export default defineNuxtModule({
+  setup (options, nuxt) {
+    nuxt.hook('ready', () => {
+      const nitro = tryUseNitro()
+      if (!nitro) {
+        // no server: skip anything that would only run there
+        return
+      }
+    })
+  },
+})
+```
+
+### Type
+
+```ts
+function tryUseNitro (): Nitro | undefined
+```
+
 ## `addServerPlugin`
 
 Add plugin to extend Nitro's runtime behavior.

package/4.api/6.nuxt-config.md

@@ -1317,6 +1317,8 @@ Specify the server builder to use for bundling the server part of your applicati
 
 By default, Nuxt uses `@nuxt/nitro-server`, which provides standalone Nitro integration. This architecture allows for different Nitro integration patterns, such as using Nitro as a Vite plugin (with the Vite Environment API).
 
+`"nitro"` and `"vite"` are shorthands for `@nuxt/nitro-server` and `@nuxt/vite-server`. The latter is experimental and implemented with Vite alone: it builds the client and ships no server of its own, so with `ssr: false` it produces a static SPA. With SSR enabled the server environment is still built, but running it is left to a Vite plugin that brings its own target or to a custom server. Server routes, route rules and prerendering are unavailable, and modules that need a server will not work.
+
 - **Type**: `string | { bundle: (nuxt: Nuxt) => Promise<void> }`
 - **Default:** `"@nuxt/nitro-server"`
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nuxt/docs-nightly",
-  "version": "4.6.0-29802927.f10d9c49",
+  "version": "4.6.0-29803063.d6c7d394",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/nuxt/nuxt.git",