文档: getLocaleName 函数在 intlayer 中

    描述

    getLocaleName 函数返回在显示语言环境 (displayLocale) 中给定语言环境 (targetLocale) 的本地化名称。如果未提供 targetLocale，则返回 displayLocale 在其自身语言中的名称。

    参数

    • displayLocale: Locales

      • 描述: 显示目标语言环境名称的语言环境。
      • 类型: 表示有效语言环境的枚举或字符串。

    • targetLocale?: Locales

      • 描述: 要本地化其名称的语言环境。
      • 类型: 可选。表示有效语言环境的枚举或字符串。

    返回值

    • 类型: string
    • 描述: 在 displayLocale 中本地化的 targetLocale 名称，或者如果未提供 targetLocale，则返回 displayLocale 的自身名称。如果未找到翻译，则返回 "Unknown locale"。

    示例用法

    typescript
    import { Locales, getLocaleName } from "intlayer";getLocaleName(Locales.ENGLISH); // 输出: "English"getLocaleName(Locales.ENGLISH, Locales.FRENCH); // 输出: "Anglais"getLocaleName(Locales.ENGLISH, Locales.ESPANOL); // 输出: "Inglés"getLocaleName(Locales.ENGLISH, Locales.ENGLISH); // 输出: "English"getLocaleName(Locales.FRENCH); // 输出: "Français"getLocaleName(Locales.FRENCH, Locales.FRENCH); // 输出: "Français"getLocaleName(Locales.FRENCH, Locales.ESPANOL); // 输出: "Francés"getLocaleName(Locales.FRENCH, Locales.ENGLISH); // 输出: "French"getLocaleName(Locales.CHINESE); // 输出: "中文"getLocaleName(Locales.CHINESE, Locales.FRENCH); // 输出: "Chinois"getLocaleName(Locales.CHINESE, Locales.ESPANOL); // 输出: "Chino"getLocaleName(Locales.CHINESE, Locales.ENGLISH); // 输出: "Chinese"getLocaleName("unknown-locale"); // 输出: "Unknown locale"

    边界情况

    • 未提供 targetLocale:
      • 函数默认为返回 displayLocale 的自身名称。
    • 缺少翻译:
      • 如果 localeNameTranslations 不包含 targetLocale 或特定 displayLocale 的条目，函数将回退到 ownLocalesName 或返回 "Unknown locale"。

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

    文档的 GitHub 链接
    getLocaleLanggetLocalizedUrl