feat(kit): useNitro() utility

docs/content/3.api/4.advanced/2.kit.md

@@ -63,13 +63,14 @@
 
 - `addTemplate(templateOptions)`
 
-### Server
+### Nitro
 
-[source code](https://github.com/nuxt/framework/blob/main/packages/kit/src/server.ts)
+[source code](https://github.com/nuxt/framework/blob/main/packages/kit/src/nitro.ts)
 
 - ~~`addServerMiddleware(serverMiddleware)`~~
 - `addServerHandler (handler)`
 - `addDevServerHandler (handler)`
+- `useNitro()` (only usable after `ready` hook)
 
 ### Resolving
 

packages/kit/src/index.ts

@@ -18,7 +18,7 @@ export * from './layout'
 export * from './pages'
 export * from './plugin'
 export * from './resolve'
-export * from './server'
+export * from './nitro'
 export * from './template'
 export * from './logger'
 

packages/kit/src/module/container.ts

@@ -3,7 +3,7 @@ import type { Nuxt, ModuleContainer } from '@nuxt/schema'
 import { chainFn } from '../internal/task'
 import { addTemplate } from '../template'
 import { addLayout } from '../layout'
-import { addServerMiddleware } from '../server'
+import { addServerMiddleware } from '../nitro'
 import { isNuxt2 } from '../compatibility'
 import { addPluginTemplate } from '../plugin'
 import { useNuxt } from '../context'

packages/kit/src/server.ts → packages/kit/src/nitro.ts

@@ -1,5 +1,5 @@
 import type { Middleware } from 'h3'
-import type { NitroEventHandler, NitroDevEventHandler } from 'nitropack'
+import type { NitroEventHandler, NitroDevEventHandler, Nitro } from 'nitropack'
 import { useNuxt } from './context'
 
 export interface LegacyServerMiddleware {
@@ -46,3 +46,26 @@ export function addServerHandler (handler: NitroEventHandler) {
 export function addDevServerHandler (handler: NitroDevEventHandler) {
   useNuxt().options.devServerHandlers.push(handler)
 }
+
+/**
+ * Access to nitro instance
+ *
+ * **Note:** You can use useNitro() You can call `useNitro()` only after `ready` hook.
+ *
+ * **Note:** Moditifcations to nitro instance configuration are not reflected.
+ *
+ * @example
+ *
+ * ```ts
+ * nuxt.hook('ready', () => {
+ *   console.log(useNitro())
+ * })
+ * ```
+ */
+export function useNitro (): Nitro {
+  const nuxt = useNuxt()
+  if (!nuxt._nitro) {
+    throw new Error('Nitro is not initialized yet. You can call `useNitro()` only after `ready` hook.')
+  }
+  return nuxt._nitro
+}

packages/nuxt/src/core/nitro.ts

@@ -134,7 +134,8 @@ export async function initNitro (nuxt: Nuxt) {
   // Init nitro
   const nitro = await createNitro(nitroConfig)
 
-  // Expose nitro to modules
+  // Expose nitro to modules and kit
+  nuxt._nitro = nitro
   await nuxt.callHook('nitro:init', nitro)
 
   // Connect vfs storages

packages/schema/src/types/nuxt.ts

@@ -1,12 +1,14 @@
 import type { Hookable } from 'hookable'
 import type { Ignore } from 'ignore'
+import type { Nitro } from 'nitropack'
 import type { NuxtHooks, NuxtLayout, NuxtMiddleware } from './hooks'
 import type { NuxtOptions } from './config'
 
 export interface Nuxt {
   // Private fields.
   _version: string
   _ignore?: Ignore
+  _nitro?: Nitro
 
   /** The resolved Nuxt configuration. */
   options: NuxtOptions

playground/nuxt.config.ts

@@ -1,3 +1,11 @@
-export default defineNuxtConfig({
+import { useNitro } from '@nuxt/kit'
 
+export default defineNuxtConfig({
+  modules: [
+    (_, nuxt) => {
+      nuxt.hook('ready', () => {
+        console.log(useNitro())
+      })
+    }
+  ]
 })