Документация: Функция getConfiguration в intlayer

Описание:

Функция getConfiguration извлекает всю конфигурацию для приложения intlayer, получая переменные окружения. Эта функция обеспечивает гибкость использования одной и той же конфигурации как на стороне клиента, так и на стороне сервера, что гарантирует согласованность приложения.

Параметры:

Функция не принимает никаких параметров. Вместо этого она использует переменные окружения для конфигурации.

Возвращает:

• Тип: IntlayerConfig

• Описание: Объект, содержащий полную конфигурацию для intlayer. Конфигурация включает в себя следующие разделы:

  • internationalization: Настройки, связанные с локалями и строгим режимом.
  • middleware: Настройки, связанные с управлением URL и куки.
  • content: Настройки, связанные с файловым содержимым, каталогами и шаблонами.
  • editor: Конфигурации, специфичные для редактора.

Смотрите документацию по конфигурации Intlayer для получения дополнительной информации.

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

Извлечение полной конфигурации:

import { getConfiguration } from "intlayer";

const config = getConfiguration();
console.log(config);
// Вывод:
// {
//   internationalization: { ... },
//   middleware: { ... },
//   content: { ... },
//   editor: { ... }
// }

Извлечение availableLocales и defaultLocale:

Раздел internationalization конфигурации предоставляет настройки, связанные с локалями, такие как locales (доступные локали) и defaultLocale (язык по умолчанию).

const { internationalization, middleware } = getConfiguration();
const { locales: availableLocales, defaultLocale } = internationalization;
const { cookieName } = middleware;

console.log(availableLocales); // Пример вывода: ["en", "fr", "es"]
console.log(defaultLocale); // Пример вывода: "en"
console.log(cookieName); // Вывод: "INTLAYER_LOCALE"

Примечания:

• Убедитесь, что все необходимые переменные окружения правильно установлены перед вызовом этой функции. Отсутствующие переменные вызовут ошибки во время инициализации.
• Эта функция может использоваться как на стороне клиента, так и на стороне сервера, что делает её универсальным инструментом для управления конфигурациями в едином формате.

Использование в приложениях:

Функция getConfiguration является основным инструментом для инициализации и управления конфигурацией приложения intlayer. Предоставляя доступ к таким настройкам, как локали, промежуточное ПО и директории содержимого, она обеспечивает согласованность и масштабируемость в многоязычных и контентно ориентированных приложениях.