Lzh on GitHub

defineI18nLocaleDetector

defineI18nLocaleDetector() 是一个可组合项，用于定义一个在服务器端检测语言环境的函数，它在服务器上对每个请求都会调用。

defineI18nLocaleDetector() 是一个可组合项，用于定义一个在服务器端检测语言环境的函数，它在服务器上对每个请求都会调用。

该函数需要返回一个语言环境字符串。

你可以在语言环境检测器函数中使用 @intlify/h3 工具函数，这些函数会自动导入。

此可组合项是实验性的。 你需要将文件路径配置到 experimental.localeDetector 选项。

类型

type LocaleConfig = {
  defaultLocale: Locale
  fallbackLocale: FallbackLocale
}
declare function defineI18nLocaleDetector(
  detector: (event: H3Event, config: LocaleConfig) => string
): (event: H3Event, config: LocaleConfig) => string

参数

detector

一个函数，作为语言环境检测器，它具有以下参数：

  • event
  • config
    • 类型：object
    • 从 Nitro 传递的语言环境配置。
    • 属性：
      • defaultLocale
        • 类型：Locale
        • 此值设置为 Nuxt i18n 的 defaultLocale 选项。如果未设置，则设置为从 Vue I18n 配置（vueI18n 选项中设置的 i18n.config 文件）加载的 locale 选项。如果两者都未设置，则使用默认值 'en-US'。
      • fallbackLocale
        • 类型：FallbackLocale
        • 此值设置为从 Vue I18n 配置（vueI18n 选项中设置的 i18n.config 文件）加载的 fallbackLocale 选项。如果没有配置回退语言环境，则默认为 false。

用法

一个语言环境检测器的示例：

// 基于查询、cookie、请求头进行检测
export default defineI18nLocaleDetector((event, config) => {
  const query = tryQueryLocale(event, { lang: '' })
  if (query) {
    return query.toString()
  }

  const cookie = tryCookieLocale(event, { lang: '', name: 'i18n_locale' })
  if (cookie) {
    return cookie.toString()
  }

  const header = tryHeaderLocale(event, { lang: '' })
  if (header) {
    return header.toString()
  }

  return config.defaultLocale
})