跳到主要内容

Nuxt Kit

@nuxt/kit 提供了面向模块作者的功能。

Nuxt Kit 提供了组合式工具函数,让与 Nuxt HooksNuxt Interface 的交互以及开发 Nuxt 模块 变得非常简单。

探索所有 Nuxt Kit 工具函数。

用法

安装依赖

你可以将最新的 Nuxt Kit 添加到你 package.jsondependencies 部分来安装它。不过,请考虑总是显式地安装 @nuxt/kit 包,即使它已经被 Nuxt 安装过了。

@nuxt/kit@nuxt/schema 是 Nuxt 的关键依赖。如果你单独安装它们,请确保 @nuxt/kit@nuxt/schema 的版本等于或高于你的 nuxt 版本,以避免任何意外行为。
package.json
{
  "dependencies": {
    "@nuxt/kit": "npm:@nuxt/kit-nightly@latest"
  }
}

导入 Kit 工具函数

test.mjs
import { useNuxt } from '@nuxt/kit'
Nuxt Kit 工具函数仅对模块可用,并不打算被导入到运行时(组件、Vue 组合式函数、页面、插件或服务端路由)中。

Nuxt Kit 是一个仅支持 ESM 的包,意味着你不能 require('@nuxt/kit')。作为变通方案,可以在 CommonJS 上下文中使用动态导入:

test.cjs
// 这样不行!
// const kit = require('@nuxt/kit')
async function main () {
  const kit = await import('@nuxt/kit')
}
main()