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 オブジェクトは、コンストラクタと同じプロパティをサポートします。

プロパティ任意説明
apiKeystring翻訳サービス用の本番用 APIキー
devApiKeystring開発用 APIキー
projectIdstring一意のプロジェクト識別子
sourceLocalestring翻訳のデフォルトのソースロケール
targetLocalestring翻訳のデフォルトのターゲットロケール
localesstring[]対応ロケールコードの配列
baseUrlstringカスタム API ベースURL
customMappingCustomMappingカスタムのロケールコードマッピング

返り値

void - このメソッドはインスタンスの設定をインプレースで更新します。


この例では、ターゲットの locale をスペイン語からフランス語に切り替えます。

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

// フランス語に切り替え
gt.setConfig({
  targetLocale: 'fr'
});

注意事項

  • 設定の変更は、以降のメソッド呼び出しに対して即時に反映されます
  • setConfig を呼び出しても環境変数は再読み込みされません
  • カスタムマッピングは既存のマッピングを完全に置き換えます(マージされません)
  • 検証に失敗しても、インスタンスの設定は変更されません
  • このメソッドは同期的に実行され、戻り値は void です

次のステップ

このガイドはいかがですか?