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

    intlayer 包

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

    安装

    bash
    npm install intlayer
    

    导出

    配置

    导入:

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

    类型

    导入:

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

    内容函数

    导入:

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

    本地化实用工具

    导入:

    tsx
    import "intlayer";
    
    函数类型描述相关文档
    getLocaleFunction从字符串或路径检测 locale。getLocale
    getLocaleLangFunction获取 locale 的语言部分。getLocaleLang
    getLocaleNameFunction获取 locale 的显示名称。getLocaleName
    getLocalizedPathFunction将规范路径解析为本地化路径。getLocalizedPath
    getCanonicalPathFunction将本地化路径解析为规范路径。getCanonicalPath
    getLocalizedUrlFunction生成本地化的 URL。getLocalizedUrl
    getMultilingualUrlsFunction为所有受支持的 locale 生成 URL。getMultilingualUrls
    getPathWithoutLocaleFunction从路径中移除 locale 前缀。getPathWithoutLocale
    getPrefixFunction从路径获取 locale 前缀。getPrefix
    comparePathsFunction忽略区域设置比较两个路径。comparePaths
    normalizePathFunction将路径规范化为与区域设置无关的路径。comparePaths
    getHTMLTextDirFunction获取文本方向(LTR/RTL)。getHTMLTextDir
    validatePrefixFunction验证区域设置前缀。validatePrefix

    浏览器工具

    导入:

    tsx
    import "intlayer";
    
    函数类型描述
    getBrowserLocaleFunction检测浏览器的首选区域设置。
    getCookieFunction检索 cookie 值。
    getLocaleFromStorageFunction从存储中检索区域设置。
    setLocaleInStorageFunction将区域设置保存到存储中。

    格式化器

    导入:

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