仪表板
GT Class

setConfig

GT setConfig 方法的 API 参考

概述

setConfig 方法用于更新现有 GT 实例的配置。 这使你可以在实例创建后修改 API 凭据、locales 以及其他设置。

const gt = new GT();

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

setConfig 方法会验证所有提供的语言代码，并与传递给构造函数的任何现有配置合并。

参考资料

参数

Prop

Type

GTConstructorParams 对象支持与构造函数相同的属性：

属性类型可选说明
apiKeystring✓生产环境翻译服务的 API key
devApiKeystring✓开发环境 API key
projectIdstring✓项目的唯一标识符
sourceLocalestring✓默认源语言（source locale）
targetLocalestring✓默认目标语言（target locale）
localesstring[]✓支持的语言代码数组
baseUrlstring✓自定义 API 基础 URL
customMappingCustomMapping✓自定义语言代码映射

返回值

void - 该方法会在原位更新实例配置。

示例

在此示例中，我们将目标 locale 从西班牙语切换为法语。

const gt = new GT({
  sourceLocale: 'en',
  targetLocale: 'es'
});

// 切换到法语
gt.setConfig({
  targetLocale: 'fr'
});

注意事项

  • 配置更改会在后续方法调用中立即生效
  • 调用 setConfig 时不会重新读取环境变量
  • 自定义映射将完全替换现有映射（不会合并）
  • 校验失败不会更改实例配置
  • 此方法为同步方法，返回 void

后续步骤

这份指南怎么样？

GT 构造函数

GT 类构造函数的 API 参考

checkFileTranslations

checkFileTranslations 方法的 API 参考：在无需下载文件的情况下检查翻译状态

本页内容

概述
参考资料
参数
返回值
示例
注意事项
后续步骤
setConfig