Documentation : Fonction getConfiguration dans intlayer

Description

La fonction getConfiguration récupère la configuration complète de l'application intlayer en extrayant les variables d'environnement. Cette fonction offre la flexibilité d'utiliser la même configuration à la fois côté client et côté serveur, garantissant ainsi une cohérence dans toute l'application.

Paramètres

La fonction ne prend aucun paramètre. Elle utilise plutôt les variables d'environnement pour la configuration.

Retour

• Type : IntlayerConfig

• Description : Un objet contenant la configuration complète pour intlayer. La configuration inclut les sections suivantes :

  • internationalization : Paramètres liés aux locales et au mode strict.
  • middleware : Paramètres liés à la gestion des URL et des cookies.
  • content : Paramètres liés aux fichiers de contenu, aux répertoires et aux modèles.
  • editor : Configurations spécifiques à l'éditeur.

Voir la documentation de configuration d'Intlayer pour plus de détails.

Exemple d'utilisation

Récupération de la configuration complète

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

Extraction de availableLocales et defaultLocale

La section internationalization de la configuration fournit des paramètres liés aux langues tels que locales (langues disponibles) et defaultLocale (langue par défaut).

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

Notes

• Assurez-vous que toutes les variables d'environnement requises sont correctement définies avant d'appeler cette fonction. L'absence de variables entraînera des erreurs lors de l'initialisation.
• Cette fonction peut être utilisée à la fois côté client et côté serveur, ce qui en fait un outil polyvalent pour gérer les configurations de manière unifiée.

Utilisation dans les applications

La fonction getConfiguration est un utilitaire fondamental pour initialiser et gérer la configuration d'une application intlayer. En fournissant un accès aux paramètres tels que les locales, le middleware et les répertoires de contenu, elle garantit la cohérence et la scalabilité des applications multilingues et orientées contenu.

Historique de la documentation

• 5.5.10 - 2025-06-29 : Historique initial