Documentation: getConfiguration 函数在 intlayer

    描述:

    getConfiguration 函数通过提取环境变量来获取 intlayer 应用程序的完整配置。此函数提供在客户端和服务器端使用相同配置的灵活性,确保应用程序的一致性。


    参数:

    此函数不接受任何参数。相反,它使用环境变量进行配置。

    返回:

    • 类型: IntlayerConfig
    • 描述: 一个包含 intlayer 完整配置的对象。配置包括以下部分:

      • internationalization: 与语言环境和严格模式相关的设置。
      • middleware: 与 URL 和 cookie 管理相关的设置。
      • content: 与内容文件、目录和模式相关的设置。
      • editor: 编辑器特定的配置。

    请参见 Intlayer 配置文档 以获取更多详细信息。


    示例用法:

    检索完整配置:

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

    提取 availableLocalesdefaultLocale

    配置的 internationalization 部分提供与语言环境相关的设置,如 locales(可用的语言环境)和 defaultLocale(备用语言)。

    typescript
    import { getConfiguration } from "intlayer";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 应用程序配置的基础工具。通过提供对语言环境、中间件和内容目录等设置的访问,它确保了多语言和内容驱动应用程序的一致性和可扩展性。

    如果您有改善此文档的想法,请随时通过在GitHub上提交拉取请求来贡献。

    文档的 GitHub 链接