GT Class
setConfig
GT の setConfig メソッドのAPIリファレンス
概要
setConfig メソッドは、既存の GT インスタンスの設定を更新します。
これにより、インスタンス作成後でも API 資格情報、対応ロケール、その他の設定を変更できます。
const gt = new GT();
gt.setConfig({
apiKey: 'your-new-api-key',
projectId: 'your-project-id',
sourceLocale: 'en',
targetLocale: 'es'
});setConfig メソッドは、渡されたすべてのロケールコードを検証し、コンストラクターに渡された既存の設定とマージします。
リファレンス
パラメータ
Prop
Type
GTConstructorParams オブジェクトは、コンストラクタと同じプロパティをサポートします:
| プロパティ | 型 | 任意 | 説明 |
|---|---|---|---|
apiKey | string | ✓ | 翻訳サービス用の本番環境 APIキー |
devApiKey | string | ✓ | 開発環境用 APIキー |
projectId | string | ✓ | 一意のプロジェクト識別子 |
sourceLocale | string | ✓ | 翻訳のデフォルトのソースロケール |
targetLocale | string | ✓ | 翻訳のデフォルトのターゲットロケール |
locales | string[] | ✓ | 対応ロケールコードの配列 |
baseUrl | string | ✓ | カスタム API ベースURL |
customMapping | CustomMapping | ✓ | カスタムのロケールコードマッピング |
戻り値
void - メソッドはインスタンスの設定をその場で更新します。
例
この例では、対象のlocaleをSpanishからFrenchに切り替えます。
const gt = new GT({
sourceLocale: 'en',
targetLocale: 'es'
});
// フランス語に切り替え
gt.setConfig({
targetLocale: 'fr'
});注意事項
- 設定の変更は、以降のメソッド呼び出しに即時反映されます
setConfigを呼び出しても、環境変数は再読み込みされません- カスタムマッピングは既存のマッピングを完全に置き換えます（マージされません）
- 検証に失敗しても、インスタンスの設定は変更されません
- このメソッドは同期的で、
voidを返します
次のステップ
このガイドはどうでしたか？