NNext.js 中文网 GitHub

preferredRegion(已弃用)

preferredRegion 路由段配置选项的 API 参考。

已弃用: preferredRegion 路由段配置已弃用。请从路由文件中移除 preferredRegion 导出。有关详情,请参阅弃用提示。

preferredRegion 选项允许你为路由段指定首选的部署区域。该值会传递给你的部署平台。

layout.tsx | page.tsx | route.ts
export const preferredRegion = // string || string[]
layout.js | page.js | route.js
export const preferredRegion = // string || string[]
  • string:将路由部署到特定区域。可用的区域代码因平台而异。例如 'iad1'。
  • string[]:将路由部署到多个特定区域。路由会部署到所有列出的区域,而不是从列表中选定的某一个。例如 ['iad1', 'sfo1']。

小知识:

  • 如果未指定 preferredRegion,它将继承最近的父级 layout 的选项。根 layout 默认为 'auto'。
  • 子段的值会覆盖父级的值,值不会合并。
  • Next.js 会将区域值传递给部署平台。具体的行为和可用的区域代码因平台而异。有关支持的值,请参阅部署平台的文档。

Vercel#

如果在 Vercel 上部署 Next.js,以前区域仅在使用 export const runtime = 'edge' 时受支持,而该方式现已弃用。可以传递以下选项:

  • 'auto'(默认):使用默认区域。
  • 'global':优先将路由部署到所有可用区域。
  • 'home':优先将路由部署到主区域(home region)。

如果传递了不受支持的值,将抛出错误。

Next.js 中文网