- Documentation
- Packages
- intlayer
- getConfiguration
Documentation: getConfiguration Fonction dans intlayer
Description:
La fonction getConfiguration récupère toute la configuration 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 serveur, assurant la cohérence de l'application.
Paramètres:
La fonction ne prend aucun paramètre. Au lieu de cela, elle utilise des variables d'environnement pour la configuration.
Retours:
- Type: IntlayerConfig
Description: Un objet contenant la configuration complète pour intlayer. La configuration comprend 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, répertoires et modèles.
- editor: Configurations spécifiques à l'éditeur.
Voir documentation de configuration d'Intlayer pour plus de détails.
Exemple d'utilisation:
Récupération de la configuration complète:
1import { getConfiguration } from "intlayer";
2
3const config = getConfiguration();
4console.log(config);
5// Sortie:
6// {
7// internationalization: { ... },
8// middleware: { ... },
9// content: { ... },
10// editor: { ... }
11// }Extraction de availableLocales et defaultLocale:
La section internationalization de la configuration fournit des paramètres liés aux locales tels que locales (locales disponibles) et defaultLocale (langue par défaut).
1const { internationalization, middleware } = getConfiguration();
2const { locales: availableLocales, defaultLocale } = internationalization;
3const { cookieName } = middleware;
4
5console.log(availableLocales); // Exemple de sortie: ["en", "fr", "es"]
6console.log(defaultLocale); // Exemple de sortie: "en"
7console.log(cookieName); // Sortie: "INTLAYER_LOCALE"Remarques:
- Assurez-vous que toutes les variables d'environnement requises sont correctement définies avant d'appeler cette fonction. Les variables manquantes provoqueront des erreurs pendant l'initialisation.
- Cette fonction peut être utilisée à la fois sur les côtés client et 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 l'évolutivité dans des applications multilingues et axées sur le contenu.
Si vous avez une idée d’amélioration pour améliorer cette documentation, n’hésitez pas à contribuer en submitant une pull request sur GitHub.
Lien GitHub de la documentation