Documentación: getConfiguration Función en intlayer

    Descripción:

    La función getConfiguration recupera toda la configuración para la aplicación intlayer extrayendo variables de entorno. Esta función proporciona la flexibilidad de usar la misma configuración tanto en el lado del cliente como en el lado del servidor, asegurando consistencia en toda la aplicación.


    Parámetros:

    La función no toma ningún parámetro. En su lugar, utiliza variables de entorno para la configuración.

    Retorna:

    • Tipo: IntlayerConfig
    • Descripción: Un objeto que contiene la configuración completa para intlayer. La configuración incluye las siguientes secciones:

      • internationalization: Configuraciones relacionadas con los locales y el modo estricto.
      • middleware: Configuraciones relacionadas con la gestión de URL y cookies.
      • content: Configuraciones relacionadas con archivos de contenido, directorios y patrones.
      • editor: Configuraciones específicas del editor.

    Vea documentación de configuración de Intlayer para más detalles.


    Ejemplo de Uso:

    Recuperando la Configuración Completa:

    typescript
    import { getConfiguration } from "intlayer";const config = getConfiguration();console.log(config);// Salida:// {//   internationalization: { ... },//   middleware: { ... },//   content: { ... },//   editor: { ... }// }

    Extrayendo availableLocales y defaultLocale:

    La sección internationalization de la configuración proporciona configuraciones relacionadas con el locale, tales como locales (locales disponibles) y defaultLocale (idioma por defecto).

    typescript
    import { getConfiguration } from "intlayer";const { internationalization, middleware } = getConfiguration();const { locales: availableLocales, defaultLocale } = internationalization;const { cookieName } = middleware;console.log(availableLocales); // Ejemplo de salida: ["en", "fr", "es"]console.log(defaultLocale); // Ejemplo de salida: "en"console.log(cookieName); // Salida: "INTLAYER_LOCALE"

    Notas:

    • Asegúrese de que todas las variables de entorno requeridas estén configuradas correctamente antes de llamar a esta función. Las variables faltantes causarán errores durante la inicialización.
    • Esta función se puede utilizar tanto en el lado del cliente como en el lado del servidor, lo que la convierte en una herramienta versátil para gestionar configuraciones de manera unificada.

    Uso en Aplicaciones:

    La función getConfiguration es una utilidad fundamental para inicializar y gestionar la configuración de una aplicación intlayer. Al proporcionar acceso a configuraciones como locales, middleware y directorios de contenido, garantiza consistencia y escalabilidad en aplicaciones multilingües y orientadas al contenido.

    Si tienes una idea para mejorar esta documentación, no dudes en contribuir enviando una pull request en GitHub.

    Enlace de GitHub a la documentación