Nuxt Prepare
Nuxt 模块,用于在构建时运行异步初始化步骤。
特性
- 🦦 零配置
- 🦎 在 Nuxt 构建应用程序时运行同步或异步操作
- ✂️ 有条件地覆盖运行时配置或应用程序配置值
- 🍡 串行或并行运行脚本
- 🥢 适用于 Nitro 服务器路由
- 🦾 通过
defineNuxtPrepareHandler
获得更好的 DX
设置
!提示📖 阅读文档
npx nuxi@latest module add prepare
基本用法
!提示📖 阅读文档
将 nuxt-prepare
模块添加到您的 nuxt.config.ts
// `nuxt.config.ts`
export default defineNuxtConfig({
modules: ['nuxt-prepare']
})
默认情况下,Nuxt Prepare 将在项目根目录中查找 server.prepare.ts
文件。要在 Nuxt 构建应用程序时运行同步或异步代码,请在项目根目录中定义一个处理程序并导出一个默认函数
// `server.prepare.ts`
import { defineNuxtPrepareHandler } from 'nuxt-prepare/config'
export default defineNuxtPrepareHandler(async () => {
// Do some async magic here, e.g. fetch data from an API
return {
// Overwrite the runtime config variable `foo`
runtimeConfig: {
public: {
foo: 'Overwritten by "server.prepare" script'
}
},
// Pass custom state to Nuxt and import it
// anywhere from `#nuxt-prepare`
state: {
foo: 'bar'
}
}
})
!提示 您可以运行任意数量的准备脚本 – 将它们添加到
prepare.scripts
模块配置中。
💻 开发
- 克隆此仓库
- 使用
corepack enable
启用 Corepack - 使用
pnpm install
安装依赖项 - 运行
pnpm run dev:prepare
- 使用
pnpm run dev
启动开发服务器
鸣谢
- Maronbeere 的变色龙像素画。
- McPizza0 的启发性
nuxt-server-init
模块。
许可证
MIT 许可证 © 2023-至今 Johann Schopplich