NNext.js 中文网 GitHub

API 参考

NextAdapter 接口中 modifyConfig 和 onBuildComplete 的参考文档。

async modifyConfig(config, context)#

在任何加载 next.config.js 文件的 CLI 命令中调用,以允许修改配置。

参数:

  • config:完整的 Next.js 配置对象
  • context.phase:当前的构建阶段(请参阅阶段)
  • context.nextVersion:正在使用的 Next.js 版本
  • context.projectDir:Next.js 项目目录的绝对路径

返回值: 修改后的配置对象(可以是异步的)

async onBuildComplete(context)#

在构建过程完成后调用,并附带有关路由和输出的详细信息。

参数:

  • context.routing:包含 Next.js 路由阶段和元数据的对象
    • routing.beforeMiddleware:在 Middleware 之前执行的路由(包括请求头和重定向处理)
    • routing.middlewareMatchers:此次构建的 Middleware matcher 定义,用于决定是否为给定请求调用 middleware
    • routing.beforeFiles:在文件系统路由匹配之前检查的 rewrite 路由
    • routing.afterFiles:在文件系统路由匹配之后检查的 rewrite 路由
    • routing.dynamicRoutes:动态路由匹配表
    • routing.onMatch:匹配成功后应用的路由(例如不可变静态资源的缓存请求头)
    • routing.fallback:最终的 rewrite 回退路由
    • routing.shouldNormalizeNextData:在匹配期间是否应规范化 /_next/data/<buildId>/... URL
    • routing.rsc:用于 React Server Components 路由行为的路由元数据
  • context.outputs:按类型组织的所有构建输出的详细信息
  • context.projectDir:Next.js 项目目录的绝对路径
  • context.repoRoot:检测到的仓库根目录的绝对路径
  • context.distDir:构建输出目录的绝对路径
  • context.config:最终的 Next.js 配置(已应用 modifyConfig)
  • context.nextVersion:正在使用的 Next.js 版本
  • context.buildId:当前构建的唯一标识符
Next.js 中文网