Creation:2026-01-21Last update:2026-01-21

    intlayer 包

    intlayer 包是 Intlayer 生态系统的核心库。它为在 JavaScript 和 TypeScript 应用中管理多语言内容提供了必要的函数、类型和实用工具。

    安装

    npm install intlayer
    yarn add intlayer
    pnpm add intlayer
    bun add intlayer

    导出

    配置

    导入：

    import "intlayer";
    变量 类型 说明 相关文档
    configuration IntlayerConfig Intlayer 的配置对象。 getConfiguration
    getConfiguration () => IntlayerConfig 返回 Intlayer 配置对象。(已弃用：请改用 configuration) getConfiguration
    locales Locales[] 所有受支持的 locales 列表。 -
    requiredLocales Locales[] 所有必需的 locales 列表。 -
    defaultLocale Locales 默认语言/区域设置。 -

    类型

    导入：

    import "intlayer";
    类型 描述
    Dictionary 用于定义字典结构的字典类型。
    DeclarationContent （已弃用）请改用 Dictionary<T>。
    IntlayerConfig 定义 Intlayer 配置的类型。
    ContentNode 字典内容中的节点。
    Locale 表示 locale 的类型。
    LocalesValues locale 的可能取值。
    StrictModeLocaleMap 具有严格类型检查的 locale 映射。

    内容函数

    导入：

    import "intlayer";
    函数 类型 描述 相关文档
    t / getTranslation Function 根据当前 locale（语言环境）选择内容。 翻译
    enu / getEnumeration Function 根据数量选择内容。 枚举
    cond / getCondition Function 根据布尔条件选择内容。 condition
    gender Function 根据性别选择内容。 gender
    insert Function 将值插入到内容字符串中。 insertion
    nest / getNesting Function 嵌套另一个字典。 nesting
    md Function 处理 Markdown 内容。 markdown
    html Function 处理 HTML 内容。 html
    file Function 处理文件内容。 file
    getDictionary Function 处理类似字典的对象（key, content）。它处理 t() 翻译、枚举等。 -
    getIntlayer Function 基于 getDictionary，但会注入从生成的声明中得到的优化版本的字典。 -

    本地化实用工具

    导入：

    import "intlayer";
    函数 类型 描述 相关文档
    getLocale Function 从字符串或路径检测 locale。 getLocale
    getLocaleLang Function 获取 locale 的语言部分。 getLocaleLang
    getLocaleName Function 获取 locale 的显示名称。 getLocaleName
    getLocalizedPath Function 将规范路径解析为本地化路径。 getLocalizedPath
    getCanonicalPath Function 将本地化路径解析为规范路径。 getCanonicalPath
    getLocalizedUrl Function 生成本地化的 URL。 getLocalizedUrl
    getMultilingualUrls Function 为所有受支持的 locale 生成 URL。 getMultilingualUrls
    getPathWithoutLocale Function 从路径中移除 locale 前缀。 getPathWithoutLocale
    getPrefix Function 从路径获取 locale 前缀。 getPrefix
    getHTMLTextDir Function 获取文本方向（LTR/RTL）。 getHTMLTextDir
    validatePrefix Function 验证区域设置前缀。 validatePrefix

    浏览器工具

    导入：

    import "intlayer";
    函数 类型 描述
    getBrowserLocale Function 检测浏览器的首选区域设置。
    getCookie Function 检索 cookie 值。
    getLocaleFromStorage Function 从存储中检索区域设置。
    setLocaleInStorage Function 将区域设置保存到存储中。

    格式化器

    导入：

    import "intlayer";
    函数 描述
    number 格式化数字。
    currency 格式化货币值。
    percentage 格式化百分比。
    compact 以简短形式格式化数字。
    date 格式化日期。
    relativeTime 格式化相对时间。
    units 格式化带单位的数值。
    Intl 标准 Intl 对象。
    为什么Intlayer？