@intlayer/docs 6.0.2-canary.0 → 6.1.0

package/docs/zh/packages/express-intlayer/index.md

@@ -1,284 +0,0 @@
----
-createdAt: 2024-08-11
-updatedAt: 2025-06-29
-title: 包文档 | express-intlayer
-description: 查看如何使用 express-intlayer 包
-keywords:
-  - Intlayer
-  - express-intlayer
-  - 国际化
-  - 文档
-  - Next.js
-  - JavaScript
-  - React
-slugs:
-  - doc
-  - packages
-  - express-intlayer
----
-
-# express-intlayer：用于国际化（i18n）Express.js 应用的 JavaScript 包
-
-**Intlayer** 是一套专为 JavaScript 开发者设计的包。它兼容 React、Next.js 和 Express.js 等框架。
-
-**`express-intlayer` 包** 允许您对 Express.js 应用进行国际化。它提供了一个中间件，用于检测用户偏好的语言环境，并返回适合该用户的词典。
-
-## 为什么要对后端进行国际化？
-
-对后端进行国际化对于有效服务全球用户至关重要。它使您的应用能够以每个用户偏好的语言提供内容和消息。这种能力提升了用户体验，并通过使应用对不同语言背景的人更易访问和相关，扩大了应用的覆盖范围。
-
-### 实际使用场景
-
-- **以用户语言显示后端错误**：当发生错误时，以用户的母语显示消息可以提高理解度，减少挫败感。这对于可能在前端组件（如提示框或模态框）中显示的动态错误消息尤其有用。
-
-- **检索多语言内容**：对于从数据库中提取内容的应用程序，国际化确保您可以以多种语言提供这些内容。这对于需要以用户偏好语言显示产品描述、文章及其他内容的电商平台或内容管理系统至关重要。
-
-- **发送多语言电子邮件**：无论是交易邮件、营销活动还是通知，以收件人语言发送邮件都能显著提升参与度和效果。
-
-- **多语言推送通知**：对于移动应用，在用户偏好的语言中发送推送通知可以增强互动和用户留存。这种个性化的触达让通知更具相关性和可操作性。
-
-- **其他通信**：来自后端的任何形式的通信，如短信、系统警报或用户界面更新，使用用户的语言都能确保信息清晰，提升整体用户体验。
-
-通过对后端进行国际化，您的应用不仅尊重文化差异，还能更好地符合全球市场需求，这使其成为扩展全球服务的关键步骤。
-
-## 为什么要集成 Intlayer？
-
-- **类型安全环境**：利用 TypeScript 确保所有内容定义精确且无错误。
-
-## 安装
-
-使用您喜欢的包管理器安装所需的包：
-
-```bash
-npm install express-intlayer
-```
-
-```bash
-yarn add express-intlayer
-```
-
-```bash
-pnpm add express-intlayer
-```
-
-### 配置 Intlayer
-
-Intlayer 提供了一个配置文件来设置您的项目。将此文件放置在项目根目录。
-
-```typescript fileName="intlayer.config.ts" codeFormat="typescript"
-import { Locales, type IntlayerConfig } from "intlayer";
-
-const config: IntlayerConfig = {
-  internationalization: {
-    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
-    defaultLocale: Locales.ENGLISH,
-  },
-};
-
-export default config;
-```
-
-```javascript fileName="intlayer.config.mjs" codeFormat="esm"
-import { Locales } from "intlayer";
-
-/** @type {import('intlayer').IntlayerConfig} */
-const config = {
-  internationalization: {
-    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
-    defaultLocale: Locales.ENGLISH,
-  },
-};
-
-export default config;
-```
-
-```javascript fileName="intlayer.config.cjs" codeFormat="commonjs"
-const { Locales } = require("intlayer");
-
-/** @type {import('intlayer').IntlayerConfig} */
-const config = {
-  internationalization: {
-    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
-    defaultLocale: Locales.ENGLISH,
-  },
-};
-
-module.exports = config;
-```
-
-> 有关可用参数的完整列表，请参阅[配置文档](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/configuration.md)。
-
-## 使用示例
-
-设置您的 Express 应用以使用 `express-intlayer`：
-
-```typescript fileName="src/index.ts" codeFormat="typescript"
-import express, { type Express } from "express";
-import { intlayer, t } from "express-intlayer";
-
-const app: Express = express();
-
-// 加载国际化请求处理器
-app.use(intlayer());
-
-// 路由
-app.get("/", (_req, res) => {
-  res.send(
-    t({
-      en: "Example of returned content in English",
-      fr: "法语返回内容示例",
-      "es-ES": "西班牙语（西班牙）返回内容示例",
-      "es-MX": "西班牙语（墨西哥）返回内容示例",
-    })
-  );
-});
-
-// 启动服务器
-app.listen(3000, () => console.log(`监听端口 3000`));
-```
-
-```javascript fileName="src/index.mjs" codeFormat="esm"
-import express from "express";
-import { intlayer, t } from "express-intlayer";
-
-const app = express();
-
-// 加载国际化请求处理程序
-app.use(intlayer());
-
-// 路由
-app.get("/", (_req, res) => {
-  res.send(
-    t({
-      en: "Example of returned content in English",
-      fr: "法语返回内容示例",
-      "es-MX": "西班牙语（墨西哥）返回内容示例",
-      "es-ES": "西班牙语（西班牙）返回内容示例",
-    })
-  );
-});
-
-// 启动服务器
-app.listen(3000, () => console.log(`监听端口 3000`));
-```
-
-```javascript fileName="src/index.cjs" codeFormat="commonjs"
-const express = require("express");
-const { intlayer, t } = require("express-intlayer");
-
-const app = express();
-
-// 加载国际化请求处理程序
-app.use(intlayer());
-
-// 路由
-app.get("/", (_req, res) => {
-  res.send(
-    t({
-      en: "Example of returned content in English",
-      fr: "法语返回内容示例",
-      "es-MX": "西班牙语（墨西哥）返回内容示例",
-      "es-ES": "西班牙语（西班牙）返回内容示例",
-    })
-  );
-});
-
-// 启动服务器
-app.listen(3000, () => console.log(`监听端口 3000`));
-```
-
-### 兼容性
-
-`express-intlayer` 完全兼容：
-
-- [`react-intlayer`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/react-intlayer/index.md) 用于 React 应用
-- [`next-intlayer`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/next-intlayer/index.md) 用于 Next.js 应用
-- [`vite-intlayer`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/vite-intlayer/index.md) 用于 Vite 应用
-
-它还可以无缝配合各种国际化解决方案，适用于不同环境，包括浏览器和 API 请求。你可以自定义中间件，通过请求头或 Cookie 来检测语言环境：
-
-```typescript fileName="intlayer.config.ts" codeFormat="typescript"
-import { Locales, type IntlayerConfig } from "intlayer";
-
-const config: IntlayerConfig = {
-  // ... 其他配置选项
-  middleware: {
-    headerName: "my-locale-header", // 自定义请求头名称
-    cookieName: "my-locale-cookie", // 自定义 Cookie 名称
-  },
-};
-
-export default config;
-```
-
-```javascript fileName="intlayer.config.mjs" codeFormat="esm"
-import { Locales } from "intlayer";
-
-/** @type {import('intlayer').IntlayerConfig} */
-const config = {
-  // ... 其他配置选项
-  middleware: {
-    headerName: "my-locale-header", // 自定义请求头名称
-    cookieName: "my-locale-cookie", // 自定义 Cookie 名称
-  },
-};
-
-export default config;
-```
-
-```javascript fileName="intlayer.config.cjs" codeFormat="commonjs"
-const { Locales } = require("intlayer");
-
-typescript fileName="intlayer.config.ts" codeFormat="typescript"
-import { Locales, type IntlayerConfig } from "intlayer";
-
-const config: IntlayerConfig = {
-  // ... 其他配置选项
-  middleware: {
-    headerName: "my-locale-header",
-    cookieName: "my-locale-cookie",
-  },
-};
-
-export default config;
-```
-
-```javascript fileName="intlayer.config.mjs" codeFormat="esm"
-import { Locales } from "intlayer";
-
-/** @type {import('intlayer').IntlayerConfig} */
-const config = {
-  // ... 其他配置选项
-  middleware: {
-    headerName: "my-locale-header",
-    cookieName: "my-locale-cookie",
-  },
-};
-
-export default config;
-```
-
-```javascript fileName="intlayer.config.cjs" codeFormat="commonjs"
-const { Locales } = require("intlayer");
-
-/** @type {import('intlayer').IntlayerConfig} */
-const config = {
-  // ... 其他配置选项
-  middleware: {
-    headerName: "my-locale-header",
-    cookieName: "my-locale-cookie",
-  },
-};
-
-module.exports = config;
-```
-
-默认情况下，`express-intlayer` 会解析 `Accept-Language` 头来确定客户端的首选语言。
-
-## `express-intlayer` 包提供的函数
-
-- [`t()`](https://github.com/aymericzip/intlayer/blob/main/docs/docs/zh/packages/express-intlayer/t.md)
-
-## 文档历史
-
-- 5.5.10 - 2025-06-29：初始化历史