文档：getMultilingualUrls 函数在 intlayer

描述：

getMultilingualUrls 函数通过为给定的 URL 添加每个支持的语言环境前缀，生成多语言 URL 的映射。它可以处理绝对和相对 URL，根据提供的配置或默认值应用适当的语言环境前缀。

参数：

url: string
- 描述：要添加语言环境前缀的原始 URL 字符串。
- 类型：string
locales: Locales[]
- 描述：可选的支持语言环境数组。默认为项目中配置的语言环境。
- 类型：Locales[]
- 默认：localesDefault
defaultLocale: Locales
- 描述：应用程序的默认语言环境。默认为项目中配置的默认语言环境。
- 类型：Locales
- 默认：defaultLocaleDefault
prefixDefault: boolean
- 描述：是否为默认语言环境添加前缀。默认为项目中配置的值。
- 类型：boolean
- 默认：prefixDefaultDefault

返回：

类型：IConfigLocales<string>
描述：一个将每个语言环境映射到其相应的多语言 URL 的对象。

示例用法：

相对 URL：

typescript

import { getMultilingualUrls, Locales } from "intlayer";

getMultilingualUrls(
  "/dashboard",
  [Locales.ENGLISH, Locales.FRENCH],
  Locales.ENGLISH,
  false
);
// 输出: {
//   en: "/dashboard",
//   fr: "/fr/dashboard"
// }

绝对 URL：

typescript

getMultilingualUrls(
  "https://example.com/dashboard",
  [Locales.ENGLISH, Locales.FRENCH],
  Locales.ENGLISH,
  true
);
// 输出: {
//   en: "https://example.com/en/dashboard",
//   fr: "https://example.com/fr/dashboard"
// }

边缘情况：

没有语言环境段：
- 函数在生成多语言映射之前会移除 URL 中的任何现有语言环境段。
默认语言环境：
- 当 prefixDefault 为 false 时，函数不会为默认语言环境添加 URL 前缀。
不支持的语言环境：
- 仅考虑 locales 数组中提供的语言环境来生成 URL。

在应用程序中的用法：

在多语言应用程序中，配置国际化设置与 locales 和 defaultLocale 对于确保显示正确的语言至关重要。以下是如何在应用程序设置中使用 getMultilingualUrls 的示例：

tsx

import { Locales, type IntlayerConfig } from "intlayer";

// 配置支持的语言环境和默认语言环境
export default {
  internationalization: {
    locales: [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
    defaultLocale: Locales.ENGLISH,
  },
} satisfies IntlayerConfig;

export default config;

上述配置确保应用程序将 ENGLISH、FRENCH 和 SPANISH 识别为支持的语言，并使用 ENGLISH 作为后备语言。

使用此配置，getMultilingualUrls 函数可以根据应用程序支持的语言环境动态生成多语言 URL 映射：

typescript

getMultilingualUrls(
  "/dashboard",
  [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
  Locales.ENGLISH
);
// 输出:
// {
//   en: "/dashboard",
//   fr: "/fr/dashboard",
//   es: "/es/dashboard"
// }

getMultilingualUrls(
  "https://example.com/dashboard",
  [Locales.ENGLISH, Locales.FRENCH, Locales.SPANISH],
  Locales.ENGLISH,
  true
);
// 输出:
// {
//   en: "https://example.com/en/dashboard",
//   fr: "https://example.com/fr/dashboard",
//   es: "https://example.com/es/dashboard"
// }

通过集成 getMultilingualUrls，开发人员可以维护多个语言之间一致的 URL 结构，从而提升用户体验和 SEO。

如果您有改善此文档的想法，请随时通过在GitHub上提交拉取请求来贡献。

文档的 GitHub 链接

getLocalizedUrl getPathWithoutLocale