Документация: функция getTranslationContent в intlayer

Описание

Функция getTranslationContent извлекает содержимое, соответствующее определённой локали, из набора настраиваемого языкового контента. Если указанная локаль не найдена, по умолчанию возвращается содержимое для локали по умолчанию, настроенной в проекте.

Параметры

• languageContent: CustomizableLanguageContent<Content>

  • Описание: Объект, содержащий переводы для различных локалей. Каждый ключ представляет локаль, а значение - соответствующее содержимое.
  • Тип: CustomizableLanguageContent<Content>
    • Content может быть любого типа, по умолчанию string.

• locale: Locales

  • Описание: Локаль, для которой необходимо получить содержимое.
  • Тип: Locales

Возвращаемое значение

• Тип: Content
• Описание: Содержимое, соответствующее указанной локали. Если локаль не найдена, возвращается содержимое локали по умолчанию.

Пример использования

Базовое использование

import { getTranslationContent, Locales } from "intlayer";

const content = getTranslationContent(
  {
    en: "Hello",
    fr: "Bonjour",
  },
  Locales.ENGLISH
);

console.log(content); // Вывод: "Bonjour"

Отсутствующая локаль:

import { getTranslationContent, Locales } from "intlayer";

const content = getTranslationContent(
  {
    en: "Hello",
    fr: "Bonjour",
  },
  Locales.SPANISH
);

console.log(content); // Вывод: "Hello" (содержимое локали по умолчанию)

Использование пользовательских типов содержимого:

import { getTranslationContent, Locales } from "intlayer";

const customContent = getTranslationContent<Record<string, string>>(
  {
    en: { greeting: "Hello" },
    fr: { greeting: "Bonjour" },
  },
  Locales.FRENCH
);

console.log(customContent.greeting); // Вывод: "Bonjour"

Крайние случаи

• Локаль не найдена:
  • Если locale не найден в languageContent, функция возвращает содержимое локали по умолчанию.
• Неполное содержимое языка:
  • Если локаль определена частично, функция не объединяет содержимое. Она строго извлекает значение указанной локали или возвращается к локали по умолчанию.
• Контроль TypeScript:
  • Если локали в languageContent не соответствуют конфигурации проекта, TypeScript потребует определения всех необходимых локалей, обеспечивая полноту и типобезопасность содержимого.