博客Dashboard
GT Class

GT 构造函数

GT 类构造函数的 API 参考

概述

GT 构造函数会创建一个 General Translation 类的新实例，提供所有翻译、格式化和 locale 相关功能的访问。

import { GT } from 'generaltranslation';

const gt = new GT({
  apiKey: 'your-api-key',
  projectId: 'your-project-id',
  sourceLocale: 'en',
  targetLocale: 'es'
});

构造函数会自动在运行环境中检查 GT_API_KEY 和 GT_PROJECT_ID 这两个环境变量，因此你可以在构造函数的参数中省略它们。 另外，它还会校验所有提供的语言代码。

参考资料

参数

Prop

Type

GTConstructorParams 对象支持以下属性：

属性类型可选说明
apiKeystring✓生产环境 API key（翻译服务）
devApiKeystring✓开发环境 API key（在开发环境中优先生效）
projectIdstring✓项目的唯一标识符
sourceLocalestring✓默认源语言（sourceLocale）
targetLocalestring✓默认 targetLocale
localesstring[]✓支持的语言代码数组
baseUrlstring✓自定义 API 基础 URL（适用于企业部署）
customMappingCustomMapping✓自定义语言代码映射及定义

返回值

返回一个新的 GT 类实例，提供所有可用的翻译与 locale 方法。

示例

基本用法

import { GT } from 'generaltranslation';

// 最简设置——使用环境变量
const gt = new GT();

使用 API 身份凭证

const gt = new GT({
  projectId: 'my-project-id',
  apiKey: 'my-api-key',
  targetLocale: 'fr'
});

使用自定义 locale 映射

可以提供自定义映射。 这使用户能够：(1) 为语言代码使用别名，(2) 覆盖标准的 BCP 47 验证，(3) 覆盖标准的 BCP 47 locale 信息。

例如，假设你想将 cn 作为 zh 的别名。 由于 General Translation API 不支持 cn，你必须指定自定义映射。

const gt = new GT({
  projectId: 'my-project-id',
  apiKey: 'my-api-key',
  targetLocale: 'es',
  customMapping: {
    'cn': { code: 'zh' }
  }
});

通过自定义映射，您还可以执行其他操作，例如添加自定义名称、emoji 等。

const gt = new GT({
  projectId: 'my-project-id',
  apiKey: 'my-api-key',
  targetLocale: 'es',
  customMapping: { 'en-US': { name: 'Mandarin', emoji: '🇫🇷' } }
});

说明

  • 所有参数均为可选，但执行 API 操作需要提供 apiKey 和 projectId
  • 构造函数会立即验证所有语言代码，对无效代码将抛出 Error
  • 自定义映射的优先级高于标准 BCP 47 的验证

后续步骤

本指南如何?

快速开始

General Translation 库快速上手指南

setConfig

GT setConfig 方法 API 参考

本页目录

概述
参考资料
参数
返回值
示例
基本用法
使用 API 身份凭证
使用自定义 locale 映射
说明
后续步骤