Nitro

Nuxt Kit 提供了一组工具来帮助您使用 Nitro。这些函数允许您添加服务器处理程序、插件和预渲染路由。

Nitro 是一个开源的 TypeScript 框架，用于构建超快速的 Web 服务器。Nuxt 使用 Nitro 作为其服务器引擎。您可以使用 useNitro 来访问 Nitro 实例，使用 addServerHandler 添加服务器处理程序，使用 addDevServerHandler 添加仅在开发模式下使用的服务器处理程序，使用 addServerPlugin 添加插件以扩展 Nitro 的运行时行为，以及使用 addPrerenderRoutes 添加由 Nitro 预渲染的路由。

`addServerHandler`

添加一个 Nitro 服务器处理程序。如果您想创建服务器中间件或自定义路由，请使用此方法。

用法

import { addServerHandler, createResolver, defineNuxtModule } from '@nuxt/kit'

export default defineNuxtModule({
  setup (options) {
    const { resolve } = createResolver(import.meta.url)

    addServerHandler({
      route: '/robots.txt',
      handler: resolve('./runtime/robots.get'),
    })
  },
})

类型

function addServerHandler (handler: NitroEventHandler): void

参数

handler: 一个具有以下属性的处理程序对象：

属性	类型	必需	说明
`handler`	`string`	`true`	事件处理器的路径。
`route`	`string`	`false`	路径前缀或路由。如果使用空字符串，则会作为中间件使用。
`middleware`	`boolean`	`false`	指定这是一个中间件处理程序。中间件会在每个路由上被调用，通常应当不返回内容以便将控制权传递给下一个处理程序。
`lazy`	`boolean`	`false`	使用懒加载导入处理程序。当您只想在需要时加载处理程序时很有用。
`method`	`string`	`false`	路由方法匹配器。如果处理程序名称包含方法名称，则该值将作为默认值使用。

示例

基础用法

您可以使用 addServerHandler 从您的模块中添加服务器处理程序。

import { addServerHandler, createResolver, defineNuxtModule } from '@nuxt/kit'

export default defineNuxtModule({
  setup (options) {
    const { resolve } = createResolver(import.meta.url)

    addServerHandler({
      route: '/robots.txt',
      handler: resolve('./runtime/robots.get'),
    })
  },
})

export default defineEventHandler(() => {
  return {
    body: `User-agent: *\nDisallow: /`,
  }
})

当您访问 /robots.txt 时，它将返回以下响应：

User-agent: *
Disallow: /

`addDevServerHandler`

添加仅在开发模式下使用的 Nitro 服务器处理程序。此处理程序将在生产构建中被排除。

用法

import { defineEventHandler } from 'h3'
import { addDevServerHandler, createResolver, defineNuxtModule } from '@nuxt/kit'

export default defineNuxtModule({
  setup () {
    addDevServerHandler({
      handler: defineEventHandler(() => {
        return {
          body: `Response generated at ${new Date().toISOString()}`,
        }
      }),
      route: '/_handler',
    })
  },
})

类型

// @errors: 2391
import type { NitroDevEventHandler } from 'nitropack/types'
// ---cut---
function addDevServerHandler (handler: NitroDevEventHandler): void

参数

handler: 一个具有以下属性的处理程序对象：

属性	类型	必需	说明
`handler`	`EventHandler`	`true`	事件处理器。
`route`	`string`	`false`	路径前缀或路由。如果使用空字符串，则会作为中间件使用。

示例

基础用法

在某些情况下，您可能希望专门为开发目的创建服务器处理程序，例如 Tailwind 配置查看器。

import { joinURL } from 'ufo'
import { addDevServerHandler, defineNuxtModule } from '@nuxt/kit'

export default defineNuxtModule({
  async setup (options, nuxt) {
    const route = joinURL(nuxt.options.app?.baseURL, '/_tailwind')

    // @ts-expect-error - tailwind-config-viewer does not have correct types
    const createServer = await import('tailwind-config-viewer/server/index.js').then(r => r.default || r) as any
    const viewerDevMiddleware = createServer({ tailwindConfigProvider: () => options, routerPrefix: route }).asMiddleware()

    addDevServerHandler({ route, handler: viewerDevMiddleware })
  },
})

`useNitro`

返回 Nitro 实例。

您只能在 ready 钩子之后调用 useNitro()。

对 Nitro 实例配置的更改不会被应用。

用法

import { defineNuxtModule, useNitro } from '@nuxt/kit'

export default defineNuxtModule({
  setup (options, nuxt) {
    const resolver = createResolver(import.meta.url)

    nuxt.hook('ready', () => {
      const nitro = useNitro()
      // 使用 Nitro 实例进行操作
    })
  },
})

类型

function useNitro (): Nitro

`addServerPlugin`

向 Nitro 添加插件以扩展其运行时行为。

您可以在 Nitro 文档中阅读有关 Nitro 插件的更多内容。

在您的插件文件中，必须显式导入 defineNitroPlugin 从 nitropack/runtime。同样的要求适用于 useRuntimeConfig 等工具。

用法

import { addServerPlugin, createResolver, defineNuxtModule } from '@nuxt/kit'

export default defineNuxtModule({
  setup () {
    const { resolve } = createResolver(import.meta.url)
    addServerPlugin(resolve('./runtime/plugin.ts'))
  },
})

类型

function addServerPlugin (plugin: string): void

参数

属性	类型	必需	说明
`plugin`	`string`	`true`	插件路径。该插件必须导出一个默认函数，该函数接受 Nitro 实例作为参数。

示例

import { addServerPlugin, createResolver, defineNuxtModule } from '@nuxt/kit'

export default defineNuxtModule({
  setup () {
    const { resolve } = createResolver(import.meta.url)
    addServerPlugin(resolve('./runtime/plugin.ts'))
  },
})

export default defineNitroPlugin((nitroApp) => {
  nitroApp.hooks.hook('request', (event) => {
    console.log('on request', event.path)
  })

  nitroApp.hooks.hook('beforeResponse', (event, { body }) => {
    console.log('on response', event.path, { body })
  })

  nitroApp.hooks.hook('afterResponse', (event, { body }) => {
    console.log('on after response', event.path, { body })
  })
})

`addPrerenderRoutes`

向 Nitro 添加要预渲染的路由。

用法

import { addPrerenderRoutes, defineNuxtModule } from '@nuxt/kit'

export default defineNuxtModule({
  meta: {
    name: 'nuxt-sitemap',
    configKey: 'sitemap',
  },
  defaults: {
    sitemapUrl: '/sitemap.xml',
    prerender: true,
  },
  setup (options) {
    if (options.prerender) {
      addPrerenderRoutes(options.sitemapUrl)
    }
  },
})

类型

function addPrerenderRoutes (routes: string | string[]): void

参数

属性	类型	必需	说明
`routes`	`string \| string[]`	`true`	要预渲染的路由或路由数组。

`addServerImports`

向服务端添加导入。这样可以使您的导入在 Nitro 中可用，而无需手动导入它们。

如果你想提供一个可在服务器和客户端环境中使用的工具，并且可以在 shared/ 目录中使用，该函数必须在 addImports 和 addServerImports 中都从同一个源文件导入，并且应具有相同的签名。该源文件不应导入任何特定于上下文的内容（例如 Nitro 上下文、Nuxt 应用上下文），否则可能会在类型检查期间导致错误。

用法

import { addServerImports, createResolver, defineNuxtModule } from '@nuxt/kit'

export default defineNuxtModule({
  setup (options) {
    const names = [
      'useStoryblok',
      'useStoryblokApi',
      'useStoryblokBridge',
      'renderRichText',
      'RichTextSchema',
    ]

    names.forEach(name =>
      addServerImports({ name, as: name, from: '@storyblok/vue' }),
    )
  },
})

类型

function addServerImports (dirs: Import | Import[]): void

参数

imports: 一个对象或对象数组，具有以下属性：

属性	类型	必需	说明
`name`	`string`	`true`	要被检测的导入名称。
`from`	`string`	`true`	要从中导入的模块说明符。
`priority`	`number`	`false`	导入的优先级；如果多个导入具有相同名称，则使用优先级最高的那个。
`disabled`	`boolean`	`false`	如果此导入被禁用。
`meta`	`Record<string, any>`	`false`	导入的元数据。
`type`	`boolean`	`false`	如果此导入是纯类型导入。
`typeFrom`	`string`	`false`	在生成类型声明时使用此值作为 `from`。
`as`	`string`	`false`	将导入作为此名称。

`addServerImportsDir`

添加一个目录以供 Nitro 扫描自动导入。

用法

import { addServerImportsDir, createResolver, defineNuxtModule } from '@nuxt/kit'

export default defineNuxtModule({
  meta: {
    name: 'my-module',
    configKey: 'myModule',
  },
  setup (options) {
    const { resolve } = createResolver(import.meta.url)
    addServerImportsDir(resolve('./runtime/server/composables'))
  },
})

类型

function addServerImportsDir (dirs: string | string[], opts: { prepend?: boolean }): void

参数

属性	类型	必需	说明
`dirs`	`string \| string[]`	`true`	要注册以供 Nitro 扫描的目录或目录数组。
`opts`	`{ prepend?: boolean }`	`false`	导入目录的选项。如果 `prepend` 为 `true`，则该目录将添加到扫描列表的开头。

示例

您可以使用 addServerImportsDir 向 Nitro 添加要扫描的目录。当您希望 Nitro 自动从自定义服务器目录导入函数时，这非常有用。

import { addServerImportsDir, createResolver, defineNuxtModule } from '@nuxt/kit'

export default defineNuxtModule({
  meta: {
    name: 'my-module',
    configKey: 'myModule',
  },
  setup (options) {
    const { resolve } = createResolver(import.meta.url)
    addServerImportsDir(resolve('./runtime/server/composables'))
  },
})

export function useApiSecret () {
  const { apiSecret } = useRuntimeConfig()
  return apiSecret
}

然后您可以在服务器代码中使用 useApiSecret 函数：

runtime/server/api/hello.ts

const useApiSecret = (): string => ''
// ---cut---
export default defineEventHandler(() => {
  const apiSecret = useApiSecret()
  // 使用 apiSecret 进行操作
})

`addServerScanDir`

添加要由 Nitro 扫描的目录。它将检查子目录，并像注册 ~/server 文件夹一样注册它们。

仅扫描 ~/server/api、~/server/routes、~/server/middleware 和 ~/server/utils。

用法

import { addServerScanDir, createResolver, defineNuxtModule } from '@nuxt/kit'

export default defineNuxtModule({
  meta: {
    name: 'my-module',
    configKey: 'myModule',
  },
  setup (options) {
    const { resolve } = createResolver(import.meta.url)
    addServerScanDir(resolve('./runtime/server'))
  },
})

类型

function addServerScanDir (dirs: string | string[], opts: { prepend?: boolean }): void

参数

属性	类型	必需	说明
`dirs`	`string \| string[]`	`true`	要注册以供 Nitro 扫描为服务器目录的目录或目录数组。
`opts`	`{ prepend?: boolean }`	`false`	导入目录的选项。如果 `prepend` 为 `true`，则该目录将添加到扫描列表的开头。

示例

您可以使用 addServerScanDir 向 Nitro 添加要扫描的目录。当您想添加自定义服务器目录时，这非常有用。

import { addServerScanDir, createResolver, defineNuxtModule } from '@nuxt/kit'

export default defineNuxtModule({
  meta: {
    name: 'my-module',
    configKey: 'myModule',
  },
  setup (options) {
    const { resolve } = createResolver(import.meta.url)
    addServerScanDir(resolve('./runtime/server'))
  },
})

export function hello () {
  return 'Hello from server utils!'
}

然后您可以在服务器代码中使用 hello 函数。

runtime/server/api/hello.ts

function hello () {
  return 'Hello from server utils!'
}
// ---cut---
export default defineEventHandler(() => {
  return hello() // Hello from server utils!
})

报告问题或者在 GitHub 上编辑此页面

模板

Nuxt Kit 提供了一组实用工具来帮助你处理模板。这些函数允许你在开发和构建时生成额外的文件。

解析路径

Nuxt Kit 提供了一组用于解析路径的实用工具。这些函数允许你解析相对于当前模块的路径，处理未知的名称或扩展名。