博客Dashboard
GT Class

setConfig

GT setConfig 方法 API 参考

概览

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

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✓开发环境的 devApiKey
projectIdstring✓项目唯一标识
sourceLocalestring✓默认源语言（sourceLocale）
targetLocalestring✓默认 targetLocale
localesstring[]✓支持的语言代码数组
baseUrlstring✓自定义 API 基础 URL
customMappingCustomMapping✓自定义语言代码映射（customMapping）

返回值

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

示例

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

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

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

说明

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

下一步

本指南如何?

本页目录

概览
参考资料
参数
返回值
示例
说明
下一步