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 对象支持以下属性：
| 属性 | 类型 | 可选 | 说明 |
|---|---|---|---|
apiKey | string | ✓ | 生产环境的翻译服务 API key |
devApiKey | string | ✓ | 开发环境 API key（在开发环境中优先使用） |
projectId | string | ✓ | 项目的唯一标识符 |
sourceLocale | string | ✓ | 默认源语言（sourceLocale） |
targetLocale | string | ✓ | 默认目标语言（targetLocale） |
locales | string[] | ✓ | 支持的语言代码数组 |
baseUrl | string | ✓ | 自定义 API 基础 URL（用于企业部署） |
customMapping | CustomMapping | ✓ | 自定义语言代码映射与定义 |
返回值
返回一个新的 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 - 构造函数会立即验证所有语言代码，对无效代码将抛出错误
- 自定义映射的优先级高于标准 BCP 47 的校验
后续步骤
- 使用
setConfig配置实例 - 通过
translate开始翻译 - 了解
GTConstructorParams类型
这份指南怎么样？