文档：intlayer 中的 getIntlayerAsync 函数

描述

getIntlayerAsync 函数通过其键选择一个字典，并为给定的语言环境解析其内容，仅加载该语言环境。

它是 getIntlayer 的异步对应物，用于在渲染之外读取字典的地方，路由 head / 元数据构建器、加载器、服务器函数。

而 getIntlayer 拉取包含每个语言环境的合并字典，构建插件（@intlayer/babel、@intlayer/swc）会将此调用重写为 getDictionaryAsync(loaderMap, key, locale)，指向 .intlayer/dynamic_dictionaries/ 中的各语言环境块。因此，bundle 只会包含实际请求的语言环境。

没有这些插件，未优化的构建，调用会通过同步字典注册表解析：内容相同，但没有各语言环境的拆分。

主要特性：

• 与 getIntlayer 相同的类型化键、选择器和返回内容
• 在优化构建中仅加载请求的语言环境块
• 针对同一块的并发调用共享单个加载
• 可安全用于 async 元数据构建器、加载器和服务器函数

函数签名

getIntlayerAsync(
  key: DictionaryKeys,                        // 必需
  localeOrSelector?: LocalesValues | DictionarySelector, // 可选
  plugins?: Plugins[]                         // 可选
): Promise<DeepTransformContent<...>>

参数

• key: DictionaryKeys

  • 描述: 要读取的字典的键，如您的内容文件中声明的那样。
  • 类型: DictionaryKeys，每个声明的字典键的并集。
  • 必需: 是

• localeOrSelector: LocalesValues | DictionarySelector

  • 描述: 用于解释内容的区域设置，或用于动态字典的选择器对象。
    • 'fr'：一个区域设置
    • { item: 2 }：一个集合项（省略 item 以获取每个项作为数组）
    • { variant: 'black-friday' }：一个命名的变体（省略以使用 default 变体）
    • { variant: { id: 'prod_abc', userId: '123' } }：一个结构化变体
    • 任何选择器都可以携带一个区域设置: { item: 2, locale: 'fr' }
  • 类型: LocalesValues | DictionarySelector
  • 必需：否（可选）。省略时，按与 getIntlayer 相同的方式解析（请求的语言环境，然后是已保存的语言环境，然后是 defaultLocale）。由于是异步函数，当请求的语言环境只能异步读取时，它还可以等待该语言环境：在 Next.js 的 Server Components、generateMetadata 和 route handler 中，它会像 next-intlayer/server 的 getLocale() 一样读取请求的 headers() 和 cookies()。这次读取会让路由切换为动态渲染，因此只有在 IntlayerProvider 尚未提供语言环境时才会进行。

• plugins: Plugins[]

  • 描述: 替换基础解释器插件的自定义节点转换器。仅限高级使用。
  • 类型: Plugins[]
  • 必需: 否（可选）

返回值

• 类型: Promise<Content>，一个 promise，解析为字典的解释内容，类型由你的声明决定。

使用示例

基本用法

import { getIntlayerAsync } from "intlayer";

const { title } = await getIntlayerAsync("app", "fr"); // "Bonjour"

getIntlayer vs getIntlayerAsync

两者接受相同的参数并返回相同的内容：在两者之间切换只会改变何时加载和加载多少。

相关函数

TypeScript

function getIntlayerAsync<
  const T extends DictionaryKeys,
  const A extends LocalesValues | DictionarySelector = DeclaredLocales,
>(
  key: T,
  localeOrSelector?: A,
  plugins?: Plugins[]
): Promise<
  DeepTransformContent<
    DictionaryRegistryResult<T, A>,
    IInterpreterPluginState,
    ExtractSelectorLocale<A>
  >
>;