@intlayer/docs 9.4.0-canary.0 → 9.4.0

package/docs/zh/packages/elysia-intlayer/exports.md

@@ -0,0 +1,136 @@
+---
+createdAt: 2026-08-24
+updatedAt: 2026-08-24
+title: elysia-intlayer 包文档
+description: Intlayer 的 Elysia 插件，提供翻译函数和 locale 检测。
+keywords:
+  - elysia-intlayer
+  - elysia
+  - plugin
+  - internationalization
+  - i18n
+slugs:
+  - doc
+  - packages
+  - elysia-intlayer
+  - exports
+history:
+  - version: 9.4.0
+    date: 2026-08-24
+    changes: "统一所有导出的文档"
+author: aymericzip
+---
+
+# elysia-intlayer 包
+
+`elysia-intlayer` 包为 Elysia 应用提供了一个处理国际化的插件。它会检测用户的 locale，并向路由上下文注入一个 `intlayer` 对象。
+
+## 安装
+
+```bash packageManager="npm"
+npm install intlayer elysia-intlayer
+```
+
+```bash packageManager="pnpm"
+pnpm add intlayer elysia-intlayer
+```
+
+```bash packageManager="yarn"
+yarn add intlayer elysia-intlayer
+```
+
+```bash packageManager="bun"
+bun add intlayer elysia-intlayer
+```
+
+> `elysia` 是一个 peer dependency（`>=1.0.0`）。Elysia 面向 **Bun** 运行时。
+
+## 导出
+
+### 插件
+
+导入：
+
+```ts
+import { intlayer } from "elysia-intlayer";
+```
+
+| 函数       | 描述                                                                                                                                                                                                                                                                | 相关文档                                                                                                       |
+| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
+| `intlayer` | 将 Intlayer 集成到你的 Elysia 应用中的 Elysia 插件。负责先从 storage（cookies、headers）、再从 `Accept-Language` 进行 locale 检测，向路由上下文注入暴露 `locale`、`t`、`getIntlayer` 和 `getDictionary` 的 `intlayer` 对象，并建立 `AsyncLocalStorage` 请求上下文。 | [intlayer](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/elysia-intlayer/intlayer.md) |
+
+### 函数
+
+导入：
+
+```ts
+import { t, getIntlayer, getDictionary } from "elysia-intlayer";
+```
+
+| 函数            | 描述                                                                                                                                                                         | 相关文档                                                                                               |
+| --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
+| `t`             | 在 Elysia 中获取当前 locale 内容的全局翻译函数。使用 `AsyncLocalStorage` 访问由 `intlayer` 插件建立的请求上下文，在其之外则回退到默认 locale。也可以通过 `intlayer.t` 访问。 | [translation](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/dictionary/translation.md) |
+| `getIntlayer`   | 从生成的声明中按 key 获取字典，并返回其在当前 locale 下的内容。`getDictionary` 的优化版本。使用 `AsyncLocalStorage` 访问请求上下文。也可以通过 `intlayer.getIntlayer` 访问。 | -                                                                                                      |
+| `getDictionary` | 处理字典对象并返回当前 locale 的内容。处理 `t()` 翻译、枚举、markdown、HTML 等。使用 `AsyncLocalStorage` 访问请求上下文。也可以通过 `intlayer.getDictionary` 访问。          | -                                                                                                      |
+
+### 类型
+
+导入：
+
+```ts
+import type { IntlayerContext, TranslateFunction } from "elysia-intlayer";
+```
+
+| 类型                | 描述                                                                                                                                                  |
+| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `IntlayerContext`   | 注入到每个路由上下文中的 `intlayer` 对象的结构：`locale`、`locale_storage`、`locale_detected`、`defaultLocale`、`t`、`getIntlayer`、`getDictionary`。 |
+| `TranslateFunction` | 翻译函数的签名，将 locale map 转换为与当前请求 locale 匹配的内容。                                                                                    |
+
+## 用法
+
+```ts fileName="src/index.ts"
+import { Elysia } from "elysia";
+import { getDictionary, getIntlayer, intlayer, t } from "elysia-intlayer";
+import dictionaryExample from "./index.content";
+
+const app = new Elysia()
+  // 加载国际化插件
+  .use(intlayer())
+  // 从路由上下文读取语言环境和辅助函数
+  .get("/", ({ intlayer }) => ({
+    locale: intlayer!.locale,
+    greeting: intlayer!.t({
+      zh: "你好",
+      en: "Hello",
+      fr: "Bonjour",
+      es: "Hola",
+    }),
+    content: intlayer!.getIntlayer("index").exampleOfContent,
+  }))
+  // 或者使用绑定到当前请求的独立辅助函数
+  .get("/t_example", () =>
+    t({
+      zh: "在中文中返回的内容示例",
+      en: "Example of returned content in English",
+      fr: "Exemple de contenu renvoyé en français",
+      es: "Ejemplo de contenido devuelto en español",
+    })
+  )
+  .get("/getIntlayer_example", () => getIntlayer("index").exampleOfContent)
+  .get(
+    "/getDictionary_example",
+    () => getDictionary(dictionaryExample).exampleOfContent
+  )
+  .listen(3000);
+
+console.log(
+  `🦊 Elysia is running at ${app.server?.hostname}:${app.server?.port}`
+);
+```
+
+> 该插件通过 **全局** `derive` 注册其上下文，Elysia 会将其类型标注为 `Partial<{ intlayer: IntlayerContext }>`。对于在 `.use(intlayer())` 之后注册的路由，该值在运行时始终存在，因此请使用非空断言（`intlayer!.locale`）或可选链，以满足 `strict` 模式下的 TypeScript。
+
+## 相关文档
+
+- [Elysia i18n - 完整指南翻译你的应用](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/intlayer_with_elysia.md)
+- [配置](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/configuration.md)

package/docs/zh/packages/elysia-intlayer/intlayer.md

@@ -0,0 +1,139 @@
+---
+createdAt: 2026-08-24
+updatedAt: 2026-08-24
+title: intlayer Elysia 插件文档 | elysia-intlayer
+description: 了解如何使用 elysia-intlayer 包中的 intlayer 插件
+keywords:
+  - intlayer
+  - elysia
+  - plugin
+  - Intlayer
+  - 国际化
+  - 文档
+slugs:
+  - doc
+  - packages
+  - elysia-intlayer
+  - intlayer
+history:
+  - version: 9.4.0
+    date: 2026-08-24
+    changes: "初始化文档"
+author: aymericzip
+---
+
+# intlayer Elysia 插件文档
+
+Elysia 的 `intlayer` 插件会检测用户的 locale，并向路由上下文注入一个 `intlayer` 对象。它同时支持在请求上下文中使用全局翻译函数。
+
+## 用法
+
+```ts fileName="src/index.ts"
+import { Elysia } from "elysia";
+import { intlayer } from "elysia-intlayer";
+
+const app = new Elysia().use(intlayer()).get("/", ({ intlayer }) =>
+  intlayer!.t({
+    zh: "你好",
+    en: "Hello",
+    fr: "Bonjour",
+    es: "Hola",
+  })
+);
+```
+
+> 该插件通过 **全局** `derive` 注册其上下文，Elysia 会将其类型标注为 `Partial<{ intlayer: IntlayerContext }>`。对于在 `.use(intlayer())` 之后注册的路由，该值在运行时始终存在，因此请使用非空断言（`intlayer!.t`）或可选链，以满足 `strict` 模式下的 TypeScript。
+
+同样的 helper 也以独立导出的形式提供，因此你可以在不解构路由上下文的情况下调用它们：
+
+```ts fileName="src/index.ts"
+import { Elysia } from "elysia";
+import { intlayer, t } from "elysia-intlayer";
+
+const app = new Elysia().use(intlayer()).get("/", () =>
+  t({
+    zh: "你好",
+    en: "Hello",
+    fr: "Bonjour",
+    es: "Hola",
+  })
+);
+```
+
+## 描述
+
+该插件执行以下任务：
+
+1. **Locale 检测**：它先从 storage（cookie、header）读取客户端显式设置的 locale，然后回退到从 `Accept-Language` 请求头协商得到的 locale。
+2. **上下文注入**：它向 Elysia 路由上下文添加一个 `intlayer` 属性（参见下方的“路由上下文”表格）。
+3. **上下文管理**：它使用 `AsyncLocalStorage` 管理异步上下文，使全局 Intlayer 函数（`t`、`getIntlayer`、`getDictionary`）无需传递上下文对象即可访问该请求特定的 locale。
+4. **字典准备**：它在创建插件时调用 `prepareIntlayer`，因此字典会在应用启动时构建。
+
+### 路由上下文
+
+| 属性              | 类型                   | 描述                                                                 |
+| ----------------- | ---------------------- | -------------------------------------------------------------------- |
+| `locale`          | `Locale`               | 本次请求要使用的 locale，`locale_storage` 优先于 `locale_detected`。 |
+| `locale_storage`  | `Locale` (可选)        | 客户端通过 cookie 或 header 显式请求的 locale。                      |
+| `locale_detected` | `Locale`               | 从请求头协商得到的 locale。                                          |
+| `defaultLocale`   | `Locale`               | 在 `intlayer.config.ts` 中配置为 fallback 的 locale。                |
+| `t`               | `TranslateFunction`    | 翻译函数。                                                           |
+| `getIntlayer`     | `typeof getIntlayer`   | 按 key 获取字典的函数。                                              |
+| `getDictionary`   | `typeof getDictionary` | 处理字典对象的函数。                                                 |
+
+> 与基于 Node 的 Intlayer 插件不同，`elysia-intlayer` 依赖 `AsyncLocalStorage` 而非 `cls-hooked`，因为 `cls-hooked` 依赖于 Bun 未实现的 `async_hooks.createHook`。
+
+请求上下文会在响应被映射后释放，因此独立的 helper 永远不会针对已经结束的请求进行解析。当在插件处理的请求之外调用时，它们会回退到配置的默认 locale。
+
+## 语言环境解析顺序
+
+默认情况下，插件按以下顺序解析语言环境：
+
+1. `INTLAYER_LOCALE` cookie。
+2. `x-intlayer-locale` 请求头。
+3. `Accept-Language` 请求头协商。
+4. 配置的 `defaultLocale`。
+
+```bash
+# 从 `Accept-Language` 协商得出
+curl -H "Accept-Language: fr" http://localhost:3000/
+# Bonjour
+
+# cookie 优先于 `Accept-Language`
+curl -H "Accept-Language: fr" -H "Cookie: INTLAYER_LOCALE=es" http://localhost:3000/
+# Hola
+
+# 请求头优先于 `Accept-Language`
+curl -H "Accept-Language: fr" -H "x-intlayer-locale: es" http://localhost:3000/
+# Hola
+```
+
+## 配置
+
+该插件会读取你的 `intlayer.config.ts` 文件。你可以自定义用于 locale 检测的 cookie 和 header：
+
+```typescript fileName="intlayer.config.ts" codeFormat={["typescript", "esm", "commonjs"]}
+import { Locales, type IntlayerConfig } from "intlayer";
+
+const config: IntlayerConfig = {
+  internationalization: {
+    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
+    defaultLocale: Locales.ENGLISH,
+  },
+  routing: {
+    storage: [
+      { type: "header", name: "my-locale-header" },
+      { type: "cookie", name: "my-locale-cookie" },
+    ],
+  },
+};
+
+export default config;
+```
+
+> 有关配置的更多信息，请访问[配置文档](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/configuration.md)。
+
+## 相关文档
+
+- [elysia-intlayer 包文档](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/elysia-intlayer/exports.md)
+- [Elysia i18n - 完整指南翻译你的应用](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/intlayer_with_elysia.md)

package/docs/zh/packages/intlayer/getDictionary.md

@@ -0,0 +1,155 @@
+---
+createdAt: 2026-08-23
+updatedAt: 2026-08-23
+title: getDictionary 函数文档 | intlayer
+description: 查看如何在 intlayer package 中使用 getDictionary 函数
+keywords:
+  - getDictionary
+  - dictionary
+  - interpreter
+  - content
+  - Intlayer
+  - intlayer
+  - Internationalization
+  - Documentation
+  - JavaScript
+  - TypeScript
+slugs:
+  - doc
+  - packages
+  - intlayer
+  - getDictionary
+history:
+  - version: 9.4.0
+    date: 2026-08-23
+    changes: "初始文档"
+author: aymericzip
+---
+
+# 文档：`intlayer` 中的 `getDictionary` 函数
+
+## 描述
+
+`getDictionary` 函数解析**您自己传递的字典对象**，并返回其为给定区域设置解析后的内容。它单次遍历内容并根据需要应用每个解析器插件，解析 `t()` 翻译、枚举、条件、插入、嵌套、markdown、HTML 和文件节点。
+
+与 [`getIntlayer`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getIntlayer.md)（在生成的注册表中按键查找字典）不同，`getDictionary` 接收字典本身。这使其成为处理在运行时构建、从 API 或 CMS 获取或在测试中声明的内容的合适工具。
+
+**主要功能：**
+
+- 适用于任何遵循字典结构（`{ key, content }`）的对象
+- 也接受合格的字典组（集合、变体）和选择器
+- 完全类型化：返回的对象镜像您传递的 `content`
+- 接受自定义解析器插件
+
+---
+
+## 函数签名
+
+```typescript
+getDictionary(
+  dictionary: Dictionary | QualifiedDictionaryGroup, // 必需
+  localeOrSelector?: LocalesValues | DictionarySelector, // 可选
+  plugins?: Plugins[]                                // 可选
+): DeepTransformContent<...>
+```
+
+---
+
+## 参数
+
+- `dictionary: Dictionary | QualifiedDictionaryGroup`
+  - **描述**: 要解释的字典（或合格字典组）。
+  - **类型**: `Dictionary | QualifiedDictionaryGroup`
+  - **必需**: 是
+
+- `localeOrSelector: LocalesValues | DictionarySelector`
+  - **描述**: 用于解释内容的区域设置，或选择器对象（`{ item }`、`{ variant }`，可选择带 `locale`）。请参阅[动态字典](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/dynamic_dictionaries/index.md)。
+  - **类型**: `LocalesValues | DictionarySelector`
+  - **必需**: 否（可选）— 默认为配置的 `defaultLocale`。
+
+- `plugins: Plugins[]`
+  - **描述**: 节点转换器数组，定义如何解释识别的节点。如果省略，将使用默认的解释器插件集。
+  - **类型**: `Plugins[]`
+  - **必需**: 否（可选）
+
+### 返回值
+
+- **类型**：字典的解释内容。
+- **描述**：你传递的 `content`，其中所有 Intlayer 节点都为请求的区域设置进行了解析。对于没有 `item` 选择器的集合组，返回一个有序的解释条目数组；当选择器不指向任何内容时，返回 `null`。
+
+---
+
+## 示例用法
+
+### 基本用法
+
+```typescript codeFormat={["typescript", "esm", "commonjs"]}
+import { getDictionary, t } from "intlayer";
+
+const content = getDictionary(
+  {
+    key: "my_key",
+    content: {
+      greeting: t({
+        zh: "你好",
+        en: "Hello",
+        fr: "Bonjour",
+      }),
+    },
+  },
+  "fr"
+);
+
+console.log(content.greeting); // "Bonjour"
+```
+
+### 解释运行时获取的内容
+
+```typescript
+import { getDictionary, type Dictionary } from "intlayer";
+
+const remoteDictionary: Dictionary = await fetch("/api/cms/banner").then(
+  (res) => res.json()
+);
+
+const banner = getDictionary(remoteDictionary, "fr");
+```
+
+### 使用选择器
+
+```typescript
+import { getDictionary } from "intlayer";
+
+// 一个合格的字典组被解析为单个条目…
+const secondItem = getDictionary(blogPostGroup, { item: 2, locale: "fr" });
+
+// …或者当没有给定 `item` 时返回一个有序数组
+const allItems = getDictionary(blogPostGroup, { locale: "fr" });
+```
+
+---
+
+## 相关函数
+
+- [`getIntlayer`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getIntlayer.md): 相同的解释，但字典是通过键在生成的注册表中查找的。
+- [`getDictionaryAsync`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getDictionaryAsync.md): 针对每个区域设置加载器映射的对应函数。
+- [`useDictionary`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/react-intlayer/useDictionary.md): 等效的 React hook，从提供程序读取区域设置。
+
+---
+
+## TypeScript
+
+```typescript
+function getDictionary<
+  const T extends Dictionary | QualifiedDictionaryGroup,
+  const A extends LocalesValues | DictionarySelector = DeclaredLocales,
+>(
+  dictionary: T,
+  localeOrSelector?: A,
+  plugins?: Plugins[]
+): DeepTransformContent<
+  ResolveQualifiedDictionaryContent<T, A>,
+  IInterpreterPluginState,
+  ExtractSelectorLocale<A>
+>;
+```

package/docs/zh/packages/intlayer/getDictionaryAsync.md

@@ -0,0 +1,166 @@
+---
+createdAt: 2026-08-23
+updatedAt: 2026-08-23
+title: getDictionaryAsync 函数文档 | intlayer
+description: 了解如何使用 intlayer 包中的 getDictionaryAsync 函数
+keywords:
+  - getDictionaryAsync
+  - dictionary
+  - dynamic dictionaries
+  - loader map
+  - bundle optimization
+  - Intlayer
+  - intlayer
+  - Internationalization
+  - Documentation
+  - JavaScript
+  - TypeScript
+slugs:
+  - doc
+  - packages
+  - intlayer
+  - getDictionaryAsync
+history:
+  - version: 9.4.0
+    date: 2026-08-23
+    changes: "Initial documentation"
+author: aymericzip
+---
+
+# Documentation: `intlayer` 中的 `getDictionaryAsync` 函数
+
+## 描述
+
+`getDictionaryAsync` 函数加载字典的**单个语言环境块**并返回其解释后的内容。
+
+它是 [`getDictionary`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getDictionary.md) 的对应物，用于在 `.intlayer/dynamic_dictionaries/` 中发出的每个语言环境加载器映射：它不是接收包含每个语言环境的字典，而是接收加载器映射并仅等待请求的语言环境所需的块。
+
+> 在应用程序代码中，你通常会调用 [`getIntlayerAsync`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getIntlayerAsync.md)，而不是这个函数。[构建插件](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/bundle_optimization.md) 会将每个 `getIntlayerAsync('key', locale)` 调用重写为 `getDictionaryAsync(loaderMap, 'key', locale)` 调用。`getDictionaryAsync` 会被导出供自定义加载器和为自己的加载器映射构建工具使用。
+
+**主要特性：**
+
+- 仅加载请求的语言环境块
+- 支持普通(`locale → loader`)和限定(`locale → qualifierId → loader`)加载器映射
+- 对同一块的并发加载进行去重，并缓存解决的内容
+- 失败的加载会从缓存中清除，以便后续调用重新尝试该块
+
+---
+
+## 函数签名
+
+```typescript
+getDictionaryAsync(
+  dictionaryLoaders: PlainDynamicLoaderMap | QualifiedDynamicLoaderMap, // 必需
+  key: string,                                           // 必需
+  localeOrSelector?: LocalesValues | DictionarySelector, // 可选
+  plugins?: Plugins[]                                    // 可选
+): Promise<DeepTransformContent<...>>
+```
+
+---
+
+## 参数
+
+- `dictionaryLoaders: PlainDynamicLoaderMap | QualifiedDynamicLoaderMap`
+  - **描述**: 按语言的加载器映射。普通映射将语言与加载器关联；限定映射（用于集合和变体）将语言与限定符 id 关联，然后与加载器关联。对于限定映射，仅加载选择器指向的块。
+  - **类型**: `PlainDynamicLoaderMap<T> | QualifiedDynamicLoaderMap`
+  - **必需**: 是
+
+- `key: string`
+  - **描述**: 字典键，用于命名块缓存。
+  - **类型**: `string`
+  - **必需**: 是
+
+- `localeOrSelector: LocalesValues | DictionarySelector`
+  - **描述**: 用于解释内容的语言，或选择器对象（`{ item }`、`{ variant }`，可选择带有 `locale`）。参见[动态字典](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/dynamic_dictionaries/index.md)。
+  - **类型**: `LocalesValues | DictionarySelector`
+  - **必需**: 否（可选）— 默认为配置的 `defaultLocale`。
+
+- `plugins: Plugins[]`
+  - **描述**: Node 转换器。默认为基础解释器集。
+  - **类型**: `Plugins[]`
+  - **必需**: 否（可选）
+
+### 返回值
+
+- **Type**: `Promise<Content>` — 一个 promise，解析为加载的 chunk 的解释内容。
+- **Description**: 当 map 对请求的 locale 及其任何 fallback 都没有发出 chunk 时，解析为 `null`，镜像缺失的合格坐标如何解析。
+
+---
+
+## 使用示例
+
+### 使用生成的 loader map
+
+```typescript codeFormat={["typescript", "esm", "commonjs"]}
+import { getDictionaryAsync } from "intlayer";
+import appLoaderMap from "../.intlayer/dynamic_dictionaries/app";
+
+const { title } = await getDictionaryAsync(appLoaderMap, "app", "fr");
+```
+
+### 使用自定义加载器映射
+
+```typescript
+import { getDictionaryAsync } from "intlayer";
+
+const loaderMap = {
+  en: () => import("./banner.en.json").then((mod) => mod.default),
+  fr: () => import("./banner.fr.json").then((mod) => mod.default),
+};
+
+const banner = await getDictionaryAsync(loaderMap, "banner", "fr");
+```
+
+### 在合格的map上使用选择器
+
+```typescript
+import { getDictionaryAsync } from "intlayer";
+
+const promoBanner = await getDictionaryAsync(bannerLoaderMap, "banner", {
+  variant: "black-friday",
+  locale: "fr",
+});
+```
+
+---
+
+## 行为注释
+
+### 缓存和去重
+
+缓存存储每个 `key + locale + selector` 三元组的 **promise**，因此对同一 chunk 的并发调用会等待单次加载。被拒绝的加载会从缓存中移除，因此失败的 chunk 会在下次调用时重试，而不是永远重放同样的失败。
+
+### 区域设置回退
+
+普通加载器映射沿着与同步模式相同的回退链进行遍历：首先是请求的区域设置，然后是其回退，如果没有发出任何块，则为 `null`。
+
+---
+
+## 相关函数
+
+- [`getIntlayerAsync`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getIntlayerAsync.md): 应用程序调用的函数；build 插件将其重写为 `getDictionaryAsync`。
+- [`getDictionary`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/intlayer/getDictionary.md): 同步对应函数，接收完整的字典。
+- [动态字典](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/dynamic_dictionaries/index.md): 集合和变体，以及它们生成的 loader 映射。
+
+---
+
+## TypeScript
+
+```typescript
+function getDictionaryAsync<
+  const T extends Dictionary,
+  const A extends LocalesValues | DictionarySelector = DeclaredLocales,
+>(
+  dictionaryLoaders: PlainDynamicLoaderMap<T> | QualifiedDynamicLoaderMap,
+  key: string,
+  localeOrSelector?: A,
+  plugins?: Plugins[]
+): Promise<
+  DeepTransformContent<
+    T["content"],
+    IInterpreterPluginState,
+    ExtractSelectorLocale<A>
+  >
+>;
+```

package/docs/zh/packages/intlayer/getEnumeration.md

@@ -31,6 +31,8 @@ author: aymericzip
 
 `getEnumeration` 函数根据枚举对象中预定义的条件，检索与特定数量对应的内容。条件以键的形式定义，其优先级由对象中键的顺序决定。
 
+有关如何声明枚举的更多详细信息，请参见[枚举文档](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/dictionary/enumeration.md)。
+
 ## 参数
 
 - `enumerationContent: QuantityContent<Content>`