国际化 API 参考
添加于:
astro@3.5.0
此模块提供了一些函数,帮助你使用项目配置的语言环境设置创建 URL。
使用 i18n 路由为你的项目创建路由将依赖于你设置的某些配置值,这些值会影响你的页面路由。使用这些函数创建路由时,请确保考虑到你的个人设置,包括:
另外,请注意,这些函数为你的 defaultLocale
创建的返回 URL 将反映你的 i18n.routing
配置。
有关功能和使用示例,请参阅我们的 i18n 路由指南。
从 astro:i18n
导入
段落标题 从 astro:i18n 导入getRelativeLocaleUrl()
段落标题 getRelativeLocaleUrl()类型:(locale: string, path?: string, options?: GetLocaleOptions) => string
getRelativeLocaleUrl(locale: string, path?: string, options?: GetLocaleOptions): string
使用此函数来检索一个语言环境的相对路径。如果该语言环境不存在,Astro 会抛出一个错误。
getAbsoluteLocaleUrl()
段落标题 getAbsoluteLocaleUrl()类型:(locale: string, path: string, options?: GetLocaleOptions) => string
当 [site
] 配置了值时,使用这个函数来检索一个语言环境的绝对路径。如果 [site
] 没有被配置,该函数将返回一个相对 URL。如果语言环境不存在,Astro 会抛出一个错误。
getRelativeLocaleUrlList()
段落标题 getRelativeLocaleUrlList()类型:(path?: string, options?: GetLocaleOptions) => string[]
像使用 getAbsoluteLocaleUrl
那样使用此函数,返回所有语言环境的绝对路径列表。
getAbsoluteLocaleUrlList()
段落标题 getAbsoluteLocaleUrlList()类型:(path?: string, options?: GetLocaleOptions) => string[]
像使用 getAbsoluteLocaleUrl
那样使用此函数,返回所有语言环境的绝对路径列表。
getPathByLocale()
段落标题 getPathByLocale()类型:(locale: string) => string
当配置了自定义语言环境路径时,此函数返回与一个或多个 codes
关联的 path
。
getLocaleByPath()
段落标题 getLocaleByPath()类型:(path: string) => string
此函数返回与语言环境 path
关联的 code
。
redirectToDefaultLocale()
段落标题 redirectToDefaultLocale()类型:(context: APIContext, statusCode?: ValidRedirectStatus) => Promise<Response>
astro@4.6.0
仅当 i18n.routing
设置为 "manual"
时可用。
此函数返回一个 Response
,将重定向到配置的 defaultLocale
。它接受一个可选的有效重定向状态码。
redirectToFallback()
段落标题 redirectToFallback()类型:(context: APIContext, response: Response) => Promise<Response>
astro@4.6.0
仅当 i18n.routing
设置为 "manual"
时可用。
此函数允许你在自己的中间件中使用你的 i18n.fallback
配置。
notFound()
段落标题 notFound()类型:(context: APIContext, response?: Response) => Promise<Response> | undefined
astro@4.6.0
仅当 i18n.routing
设置为 "manual"
时可用。
当以下情况发生时,在你的路由中间件中使用此函数来返回一个 404 错误:
- 当前路径不是根路径。例如:
/
或/<base>
- URL 中不包含语言环境代码
当传递了一个 Response
,由此函数发出的新 Response
将包含原始响应的相同头信息。
middleware()
段落标题 middleware()类型:(options: { prefixDefaultLocale: boolean, redirectToDefaultLocale: boolean }) => MiddlewareHandler
astro@4.6.0
仅当 i18n.routing
设置为 "manual"
时可用。
此函数允许你以编程方式创建 Astro i18n 中间件。
当你仍然想要使用默认的 i18n 逻辑,但只在你的网站添加少数例外时,这个功能非常有用。
requestHasLocale()
段落标题 requestHasLocale()类型:(context: APIContext) => boolean
astro@4.6.0
仅当 i18n.routing
设置为 "manual"
时可用。
检查当前 URL 是否包含已配置的语言环境代码。在内部,此函数将使用 APIContext#url.pathname
。